USB_Host_Shield_2.0/_r_e_a_d_m_e_8md_source.html
2016-04-19 18:16:46 +02:00

98 lines
54 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>USB Host Shield 2.0: README.md Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<!-- 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 class="header">
<div class="headertitle">
<div class="title">README.md</div> </div>
</div><!--header-->
<div class="contents">
<a href="_r_e_a_d_m_e_8md.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;# USB Host Library Rev.2.0</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;The code is released under the GNU General Public License.</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;__________</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;[![Build Status](https://travis-ci.org/felis/USB_Host_Shield_2.0.svg)](https://travis-ci.org/felis/USB_Host_Shield_2.0)</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;# Summary</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;This is Revision 2.0 of MAX3421E-based USB Host Shield Library for AVR&#39;s.</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;Project main web site is: &lt;http://www.circuitsathome.com&gt;.</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;Some information can also be found at: &lt;http://blog.tkjelectronics.dk/&gt;.</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;The shield can be purchased at the main site: &lt;http://www.circuitsathome.com/products-page/arduino-shields&gt; or from [TKJ Electronics](http://tkjelectronics.com/): &lt;http://shop.tkjelectronics.dk/product_info.php?products_id=43&gt;.</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;![USB Host Shield](http://shop.tkjelectronics.dk/images/USB_Host_Shield1.jpg)</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;For more information about the hardware see the [Hardware Manual](http://www.circuitsathome.com/usb-host-shield-hardware-manual).</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;# Developed By</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;* __Oleg Mazurov, Circuits\@Home__ - &lt;mazurov@circuitsathome.com&gt;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;* __Alexei Glushchenko, Circuits\@Home__ - &lt;alex-gl@mail.ru&gt;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; * Developers of the USB Core, HID, FTDI, ADK, ACM, and PL2303 libraries</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;* __Kristian Lauszus, TKJ Electronics__ - &lt;kristianl@tkjelectronics.com&gt;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; * Developer of the [BTD](#bluetooth-libraries), [BTHID](#bthid-library), [SPP](#spp-library), [PS4](#ps4-library), [PS3](#ps3-library), [Wii](#wii-library), [Xbox](#xbox-library), and [PSBuzz](#ps-buzz-library) libraries</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;* __Andrew Kroll__ - &lt;xxxajk@gmail.com&gt;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; * Major contributor to mass storage code</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;* __guruthree__</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; * [Xbox ONE](#xbox-one-library) controller support</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;* __Yuuichi Akagawa__ - [\@YuuichiAkagawa](https://twitter.com/yuuichiakagawa)</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; * Developer of the [MIDI](#midi-library) library</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;# Donate</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;Help yourself by helping us support you! Many thousands of hours have been spent developing the USB Host Shield library. Since you find it useful, please consider donating via the button below. Donations will allow us to support you by ensuring hardware that you have can be acquired in order to add support for your microcontroller board.</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;&lt;a href=&quot;https://www.paypal.com/cgi-bin/webscr?cmd=_donations&amp;amp;business=donate@circuitsathome.com&amp;amp;lc=US&amp;amp;item_name=Donate%20to%20the%20USB%20Host%20Library%20project&amp;amp;no_note=0&amp;amp;currency_code=USD&amp;amp;bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHostedGuest&quot;&gt;&lt;img src=&quot;https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif&quot; alt=&quot;PayPal - The safer, easier way to pay online!&quot; /&gt;&lt;/a&gt;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;# Table of Contents</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;* [How to include the library](#how-to-include-the-library)</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; * [Arduino Library Manager](#arduino-library-manager)</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; * [Manual installation](#manual-installation)</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;* [How to use the library](#how-to-use-the-library)</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; * [Documentation](#documentation)</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; * [Enable debugging](#enable-debugging)</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; * [Boards](#boards)</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; * [Bluetooth libraries](#bluetooth-libraries)</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; * [BTHID library](#bthid-library)</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; * [SPP library](#spp-library)</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; * [PS4 Library](#ps4-library)</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; * [PS3 Library](#ps3-library)</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; * [Xbox Libraries](#xbox-libraries)</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; * [Xbox library](#xbox-library)</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; * [Xbox 360 Library](#xbox-360-library)</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; * [Xbox ONE Library](#xbox-one-library)</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; * [Wii library](#wii-library)</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; * [PS Buzz Library](#ps-buzz-library)</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; * [HID Libraries](#hid-libraries)</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; * [MIDI Library](#midi-library)</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;* [Interface modifications](#interface-modifications)</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;* [FAQ](#faq)</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;# How to include the library</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;### Arduino Library Manager</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;First install Arduino IDE version 1.6.2 or newer, then simply use the Arduino Library Manager to install the library.</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;Please see the following page for instructions: &lt;http://www.arduino.cc/en/Guide/Libraries#toc3&gt;.</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;### Manual installation</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;First download the library by clicking on the following link: &lt;https://github.com/felis/USB_Host_Shield_2.0/archive/master.zip&gt;.</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;Then uncompress the zip folder and rename the directory to &quot;USB\_Host\_Shield\_20&quot;, as any special characters are not supported by the Arduino IDE.</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;Now open up the Arduino IDE and open &quot;File&gt;Preferences&quot;. There you will see the location of your sketchbook. Open that directory and create a directory called &quot;libraries&quot; inside that directory.</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;Now move the &quot;USB\_Host\_Shield\_20&quot; directory to the &quot;libraries&quot; directory.</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;The final structure should look like this:</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;* Arduino/</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; * libraries/</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; * USB\_Host\_Shield\_20/</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;Now quit the Arduino IDE and reopen it.</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;Now you should be able to go open all the examples codes by navigating to &quot;File&gt;Examples&gt;USB\_Host\_Shield\_20&quot; and then select the example you will like to open.</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;For more information visit the following sites: &lt;http://arduino.cc/en/Guide/Libraries&gt; and &lt;https://learn.adafruit.com/adafruit-all-about-arduino-libraries-install-use&gt;.</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;# How to use the library</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;### Documentation</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;Documentation for the library can be found at the following link: &lt;http://felis.github.com/USB_Host_Shield_2.0/&gt;.</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;### Enable debugging</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;By default serial debugging is disabled. To turn it on simply change ```ENABLE_UHS_DEBUGGING``` to 1 in [settings.h](settings.h) like so:</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;```C++</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;#define ENABLE_UHS_DEBUGGING 1</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;```</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;### Boards</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;Currently the following boards are supported by the library:</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;* All official Arduino AVR boards (Uno, Duemilanove, Mega, Mega 2560, Mega ADK, Leonardo etc.)</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;* Arduino Due, Intel Galileo, Intel Galileo 2, and Intel Edison</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; * Note that the Intel Galileo uses pin 2 and 3 as INT and SS pin respectively by default, so some modifications to the shield are needed. See the &quot;Interface modifications&quot; section in the [hardware manual](https://www.circuitsathome.com/usb-host-shield-hardware-manual) for more information.</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; * Note native USB host is not supported on any of these platforms. You will have to use the shield for now.</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;* Teensy (Teensy++ 1.0, Teensy 2.0, Teensy++ 2.0, Teensy 3.x, and Teensy LC)</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; * Note if you are using the Teensy 3.x you should download this SPI library as well: &lt;https://github.com/xxxajk/spi4teensy3&gt;. You should then add ```#include &lt;spi4teensy3.h&gt;``` to your .ino file.</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;* Balanduino</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;* Sanguino</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;* Black Widdow</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;* RedBearLab nRF51822</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;* Digilent chipKIT</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; * Please see: &lt;http://www.circuitsathome.com/mcu/usb/running-usb-host-code-on-digilent-chipkit-board&gt;.</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;* STM32F4</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; * Currently the [NUCLEO-F446RE](http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1847/PF262063) is supported featuring the STM32F446. Take a look at the following example code: &lt;https://github.com/Lauszus/Nucleo_F446RE_USBHost&gt;.</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;The following boards need to be activated manually in [settings.h](settings.h):</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;* Arduino Mega ADK</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; * If you are using Arduino 1.5.5 or newer there is no need to activate the Arduino Mega ADK manually</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;* Black Widdow</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;Simply set the corresponding value to 1 instead of 0.</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;### [Bluetooth libraries](BTD.cpp)</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;The [BTD library](BTD.cpp) is a general purpose library for an ordinary Bluetooth dongle.</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;This library make it easy to add support for different Bluetooth services like a PS3 or a Wii controller or SPP which is a virtual serial port via Bluetooth.</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;Some different examples can be found in the [example directory](examples/Bluetooth).</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;The BTD library also makes it possible to use multiple services at once, the following example sketch is an example of this:</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;[PS3SPP.ino](examples/Bluetooth/PS3SPP/PS3SPP.ino).</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;### [BTHID library](BTHID.cpp)</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;The [Bluetooth HID library](BTHID.cpp) allows you to connect HID devices via Bluetooth to the USB Host Shield.</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;Currently HID mice and keyboards are supported.</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;It uses the standard Boot protocol by default, but it is also able to use the Report protocol as well. You would simply have to call ```setProtocolMode()``` and then parse ```HID_RPT_PROTOCOL``` as an argument. You will then have to modify the parser for your device. See the example: [BTHID.ino](examples/Bluetooth/BTHID/BTHID.ino) for more information.</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;The [PS4 library](#ps4-library) also uses this class to handle all Bluetooth communication.</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;For information see the following blog post: &lt;http://blog.tkjelectronics.dk/2013/12/bluetooth-hid-devices-now-supported-by-the-usb-host-library/&gt;.</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;### [SPP library](SPP.cpp)</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;SPP stands for &quot;Serial Port Profile&quot; and is a Bluetooth protocol that implements a virtual comport which allows you to send data back and forth from your computer/phone to your Arduino via Bluetooth.</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;It has been tested successfully on Windows, Mac OS X, Linux, and Android.</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;Take a look at the [SPP.ino](examples/Bluetooth/SPP/SPP.ino) example for more information.</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;More information can be found at these blog posts:</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;* &lt;http://www.circuitsathome.com/mcu/bluetooth-rfcommspp-service-support-for-usb-host-2-0-library-released&gt;</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160;* &lt;http://blog.tkjelectronics.dk/2012/07/rfcommspp-library-for-arduino/&gt;</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160;</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160;To implement the SPP protocol I used a Bluetooth sniffing tool called [PacketLogger](http://www.tkjelectronics.com/uploads/PacketLogger.zip) developed by Apple.</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;It enables me to see the Bluetooth communication between my Mac and any device.</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;### PS4 Library</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;The PS4BT library is split up into the [PS4BT](PS4BT.h) and the [PS4USB](PS4USB.h) library. These allow you to use the Sony PS4 controller via Bluetooth and USB.</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;The [PS4BT.ino](examples/Bluetooth/PS4BT/PS4BT.ino) and [PS4USB.ino](examples/PS4USB/PS4USB.ino) examples shows how to easily read the buttons, joysticks, touchpad and IMU on the controller via Bluetooth and USB respectively. It is also possible to control the rumble and light on the controller and get the battery level.</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;Before you can use the PS4 controller via Bluetooth you will need to pair with it.</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160;</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;Simply create the PS4BT instance like so: ```PS4BT PS4(&amp;Btd, PAIR);``` and then hold down the Share button and then hold down the PS without releasing the Share button. The PS4 controller will then start to blink rapidly indicating that it is in pairing mode.</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160;</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160;It should then automatically pair the dongle with your controller. This only have to be done once.</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160;</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160;For information see the following blog post: &lt;http://blog.tkjelectronics.dk/2014/01/ps4-controller-now-supported-by-the-usb-host-library/&gt;.</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160;Also check out this excellent Wiki by Frank Zhao about the PS4 controller: &lt;http://eleccelerator.com/wiki/index.php?title=DualShock_4&gt; and this Linux driver: &lt;https://github.com/chrippa/ds4drv&gt;.</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160;</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160;### PS3 Library</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160;</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160;These libraries consist of the [PS3BT](PS3BT.cpp) and [PS3USB](PS3USB.cpp). These libraries allows you to use a Dualshock 3, Navigation or a Motion controller with the USB Host Shield both via Bluetooth and USB.</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160;</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160;In order to use your Playstation controller via Bluetooth you have to set the Bluetooth address of the dongle internally to your PS3 Controller. This can be achieved by first plugging in the Bluetooth dongle and wait a few seconds. Now plug in the controller via USB and wait until the LEDs start to flash. The library has now written the Bluetooth address of the dongle to the PS3 controller.</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160;</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160;Finally simply plug in the Bluetooth dongle again and press PS on the PS3 controller. After a few seconds it should be connected to the dongle and ready to use.</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160;</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160;__Note:__ You will have to plug in the Bluetooth dongle before connecting the controller, as the library needs to read the address of the dongle. Alternatively you could set it in code like so: [PS3BT.ino#L20](examples/Bluetooth/PS3BT/PS3BT.ino#L20).</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160;</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160;For more information about the PS3 protocol see the official wiki: &lt;https://github.com/felis/USB_Host_Shield_2.0/wiki/PS3-Information&gt;.</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160;</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160;Also take a look at the blog posts:</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160;</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160;* &lt;http://blog.tkjelectronics.dk/2012/01/ps3-controller-bt-library-for-arduino/&gt;</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160;* &lt;http://www.circuitsathome.com/mcu/sony-ps3-controller-support-added-to-usb-host-library&gt;</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160;* &lt;http://www.circuitsathome.com/mcu/arduino/interfacing-ps3-controllers-via-usb&gt;</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;A special thanks go to the following people:</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160;</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160;1. _Richard Ibbotson_ who made this excellent guide: &lt;http://www.circuitsathome.com/mcu/ps3-and-wiimote-game-controllers-on-the-arduino-host-shield-part&gt;</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160;2. _Tomoyuki Tanaka_ for releasing his code for the Arduino USB Host shield connected to the wiimote: &lt;http://www.circuitsathome.com/mcu/rc-car-controlled-by-wii-remote-on-arduino&gt;</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160;</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160;Also a big thanks all the people behind these sites about the Motion controller:</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160;</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160;* &lt;http://thp.io/2010/psmove/&gt;</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160;* &lt;http://www.copenhagengamecollective.org/unimove/&gt;</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160;* &lt;https://github.com/thp/psmoveapi&gt;</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160;* &lt;http://code.google.com/p/moveonpc/&gt;</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160;</div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160;### Xbox Libraries</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160;</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160;The library supports both the original Xbox controller via USB and the Xbox 360 controller both via USB and wirelessly.</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160;</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160;#### Xbox library</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160;</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160;The [XBOXOLD](XBOXOLD.cpp) class implements support for the original Xbox controller via USB.</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160;</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160;All the information are from the following sites:</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160;</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160;* &lt;https://github.com/torvalds/linux/blob/master/Documentation/input/xpad.txt&gt;</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160;* &lt;https://github.com/torvalds/linux/blob/master/drivers/input/joystick/xpad.c&gt;</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160;* &lt;http://euc.jp/periphs/xbox-controller.ja.html&gt;</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160;* &lt;https://github.com/Grumbel/xboxdrv/blob/master/PROTOCOL#L15&gt;</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160;</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160;#### Xbox 360 Library</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160;</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160;The library support one Xbox 360 via USB or up to four Xbox 360 controllers wirelessly by using a [Xbox 360 wireless receiver](http://blog.tkjelectronics.dk/wp-content/uploads/xbox360-wireless-receiver.jpg).</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160;</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160;To use it via USB use the [XBOXUSB](XBOXUSB.cpp) library or to use it wirelessly use the [XBOXRECV](XBOXRECV.cpp) library.</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160;</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160;__Note that a Wireless controller can NOT be used via USB!__</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160;</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160;Examples code can be found in the [examples directory](examples/Xbox).</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160;</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160;Also see the following blog posts:</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160;</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160;* &lt;http://www.circuitsathome.com/mcu/xbox360-controller-support-added-to-usb-host-shield-2-0-library&gt;</div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160;* &lt;http://blog.tkjelectronics.dk/2012/07/xbox-360-controller-support-added-to-the-usb-host-library/&gt;</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160;* &lt;http://blog.tkjelectronics.dk/2012/12/xbox-360-receiver-added-to-the-usb-host-library/&gt;</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160;</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160;All the information regarding the Xbox 360 controller protocol are form these sites:</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160;</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160;* &lt;http://tattiebogle.net/index.php/ProjectRoot/Xbox360Controller/UsbInfo&gt;</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>&#160;* &lt;http://tattiebogle.net/index.php/ProjectRoot/Xbox360Controller/WirelessUsbInfo&gt;</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span>&#160;* &lt;https://github.com/Grumbel/xboxdrv/blob/master/PROTOCOL&gt;</div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span>&#160;</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160;#### Xbox ONE Library</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160;</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160;An Xbox ONE controller is supported via USB in the [XBOXONE](XBOXONE.cpp) class. It is heavily based on the 360 library above. In addition to cross referencing the above, information on the protocol was found at:</div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160;</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160;* &lt;https://github.com/quantus/xbox-one-controller-protocol&gt;</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160;* &lt;https://github.com/torvalds/linux/blob/master/drivers/input/joystick/xpad.c&gt;</div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>&#160;* &lt;https://github.com/kylelemons/xbox/blob/master/xbox.go&gt;</div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span>&#160;</div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160;### [Wii library](Wii.cpp)</div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160;</div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160;The [Wii](Wii.cpp) library support the Wiimote, but also the Nunchuch and Motion Plus extensions via Bluetooth. The Wii U Pro Controller and Wii Balance Board are also supported via Bluetooth.</div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>&#160;</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160;First you have to pair with the controller, this is done automatically by the library if you create the instance like so:</div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>&#160;</div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span>&#160;```C++</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span>&#160;WII Wii(&amp;Btd, PAIR);</div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>&#160;```</div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span>&#160;</div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span>&#160;And then press 1 &amp; 2 at once on the Wiimote or the SYNC buttons if you are using a Wii U Pro Controller or a Wii Balance Board.</div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160;</div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span>&#160;After that you can simply create the instance like so:</div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span>&#160;</div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span>&#160;```C++</div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span>&#160;WII Wii(&amp;Btd);</div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span>&#160;```</div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span>&#160;</div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span>&#160;Then just press any button on the Wiimote and it will then connect to the dongle.</div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span>&#160;</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span>&#160;Take a look at the example for more information: [Wii.ino](examples/Bluetooth/Wii/Wii.ino).</div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span>&#160;</div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160;Also take a look at the blog post:</div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160;</div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span>&#160;* &lt;http://blog.tkjelectronics.dk/2012/08/wiimote-added-to-usb-host-library/&gt;</div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160;</div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span>&#160;The Wii IR camera can also be used, but you will have to activate the code for it manually as it is quite large. Simply set ```ENABLE_WII_IR_CAMERA``` to 1 in [settings.h](settings.h).</div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span>&#160;</div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span>&#160;The [WiiIRCamera.ino](examples/Bluetooth/WiiIRCamera/WiiIRCamera.ino) example shows how it can be used.</div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160;</div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span>&#160;All the information about the Wii controllers are from these sites:</div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160;</div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160;* &lt;http://wiibrew.org/wiki/Wiimote&gt;</div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span>&#160;* &lt;http://wiibrew.org/wiki/Wiimote/Extension_Controllers&gt;</div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span>&#160;* &lt;http://wiibrew.org/wiki/Wiimote/Extension_Controllers/Nunchuck&gt;</div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span>&#160;* &lt;http://wiibrew.org/wiki/Wiimote/Extension_Controllers/Wii_Motion_Plus&gt;</div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span>&#160;* &lt;http://wiibrew.org/wiki/Wii_Balance_Board&gt;</div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160;* The old library created by _Tomoyuki Tanaka_: &lt;https://github.com/moyuchin/WiiRemote_on_Arduino&gt; also helped a lot.</div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span>&#160;</div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span>&#160;### [PS Buzz Library](PSBuzz.cpp)</div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span>&#160;</div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span>&#160;This library implements support for the Playstation Buzz controllers via USB.</div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span>&#160;</div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span>&#160;It is essentially just a wrapper around the [HIDUniversal](hiduniversal.cpp) which takes care of the initializing and reading of the controllers. The [PSBuzz](PSBuzz.cpp) class simply inherits this and parses the data, so it is easy for users to read the buttons and turn the big red button on the controllers on and off.</div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160;</div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span>&#160;The example [PSBuzz.ino](examples/PSBuzz/PSBuzz.ino) shows how one can do this with just a few lines of code.</div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span>&#160;</div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span>&#160;More information about the controller can be found at the following sites:</div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span>&#160;</div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span>&#160;* http://www.developerfusion.com/article/84338/making-usb-c-friendly/</div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span>&#160;* https://github.com/torvalds/linux/blob/master/drivers/hid/hid-sony.c</div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span>&#160;</div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span>&#160;### HID Libraries</div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span>&#160;</div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span>&#160;HID devices are also supported by the library. However these require you to write your own driver. A few example are provided in the [examples/HID](examples/HID) directory. Including an example for the [SteelSeries SRW-S1 Steering Wheel](examples/HID/SRWS1/SRWS1.ino).</div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span>&#160;</div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span>&#160;### [MIDI Library](usbh_midi.cpp)</div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span>&#160;</div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span>&#160;The library support MIDI devices. </div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span>&#160;You can convert USB MIDI keyboard to legacy serial MIDI.</div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span>&#160;</div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span>&#160;* [USB_MIDI_converter.ino](USBH_MIDI/USB_MIDI_converter) </div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span>&#160;* [USB_MIDI_converter_multi.ino](USBH_MIDI/USB_MIDI_converter_multi) </div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span>&#160;</div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160;For information see the following page: &lt;http://yuuichiakagawa.github.io/USBH_MIDI/&gt;.</div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160;</div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160;# Interface modifications</div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span>&#160;</div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span>&#160;The shield is using SPI for communicating with the MAX3421E USB host controller. It uses the SCK, MISO and MOSI pins via the ICSP on your board.</div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span>&#160;</div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160;Note this means that it uses pin 13, 12, 11 on an Arduino Uno, so these pins can not be used for anything else than SPI communication!</div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span>&#160;</div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span>&#160;Furthermore it uses one pin as SS and one INT pin. These are by default located on pin 10 and 9 respectively. They can easily be reconfigured in case you need to use them for something else by cutting the jumper on the shield and then solder a wire from the pad to the new pin.</div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span>&#160;</div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span>&#160;After that you need modify the following entry in [UsbCore.h](UsbCore.h):</div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span>&#160;</div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span>&#160;```C++</div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span>&#160;typedef MAX3421e&lt;P10, P9&gt; MAX3421E;</div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span>&#160;```</div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span>&#160;</div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span>&#160;For instance if you have rerouted SS to pin 7 it should read:</div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span>&#160;</div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span>&#160;```C++</div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span>&#160;typedef MAX3421e&lt;P7, P9&gt; MAX3421E;</div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span>&#160;```</div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span>&#160;</div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160;See the &quot;Interface modifications&quot; section in the [hardware manual](https://www.circuitsathome.com/usb-host-shield-hardware-manual) for more information.</div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160;</div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span>&#160;# FAQ</div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span>&#160;</div><div class="line"><a name="l00352"></a><span class="lineno"> 352</span>&#160;&gt; When I plug my device into the USB connector nothing happens?</div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span>&#160;</div><div class="line"><a name="l00354"></a><span class="lineno"> 354</span>&#160;* Try to connect a external power supply to the Arduino - this solves the problem in most cases.</div><div class="line"><a name="l00355"></a><span class="lineno"> 355</span>&#160;* You can also use a powered hub between the device and the USB Host Shield. You should then include the USB hub library: ```#include &lt;usbhub.h&gt;``` and create the instance like so: ```USBHub Hub1(&amp;Usb);```.</div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span>&#160;</div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span>&#160;&gt; When I connecting my PS3 controller I get a output like this:</div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span>&#160;</div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span>&#160;```</div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span>&#160;Dualshock 3 Controller Enabled</div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span>&#160;</div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span>&#160;LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0</div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span>&#160;LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0</div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span>&#160;LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0</div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span>&#160;LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0</div><div class="line"><a name="l00366"></a><span class="lineno"> 366</span>&#160;LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0</div><div class="line"><a name="l00367"></a><span class="lineno"> 367</span>&#160;```</div><div class="line"><a name="l00368"></a><span class="lineno"> 368</span>&#160;</div><div class="line"><a name="l00369"></a><span class="lineno"> 369</span>&#160;* This means that your dongle does not support 2.0+EDR, so you will need another dongle. Please see the following [list](https://github.com/felis/USB_Host_Shield_2.0/wiki/Bluetooth-dongles) for tested working dongles.</div><div class="line"><a name="l00370"></a><span class="lineno"> 370</span>&#160;</div><div class="line"><a name="l00371"></a><span class="lineno"> 371</span>&#160;&gt; When compiling I am getting the following error: &quot;fatal error: SPI.h: No such file or directory&quot;.</div><div class="line"><a name="l00372"></a><span class="lineno"> 372</span>&#160;</div><div class="line"><a name="l00373"></a><span class="lineno"> 373</span>&#160;* Please make sure to include the SPI library like so: ```#include &lt;SPI.h&gt;``` in your .ino file.</div></div><!-- fragment --></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>