USB Host Shield 2.0
README.md
Go to the documentation of this file.
1 # USB Host Library Rev.2.0
2 
3 The code is released under the GNU General Public License.
4 __________
5 [![Build Status](https://travis-ci.org/felis/USB_Host_Shield_2.0.svg?branch=master)](https://travis-ci.org/felis/USB_Host_Shield_2.0)
6 
7 # Summary
8 This is Revision 2.0 of MAX3421E-based USB Host Shield Library for AVR's.
9 
10 Project main web site is: <https://chome.nerpa.tech/arduino_usb_host_shield_projects/>.
11 
12 Some information can also be found at: <http://blog.tkjelectronics.dk/>.
13 
14 The shield can be purchased from [TKJ Electronics](http://tkjelectronics.com/): <http://shop.tkjelectronics.dk/product_info.php?products_id=43>.
15 
16 ![USB Host Shield](http://shop.tkjelectronics.dk/images/USB_Host_Shield1.jpg)
17 
18 For more information about the hardware see the [Hardware Manual](https://chome.nerpa.tech/usb-host-shield-hardware-manual/).
19 
20 # Developed By
21 
22 * __Oleg Mazurov__ - <mazurov@gmail.com>
23 * __Alexei Glushchenko__ - <alex-gl@mail.ru>
24  * Developers of the USB Core, HID, FTDI, ADK, ACM, and PL2303 libraries
25 * __Kristian Sloth Lauszus__ - <lauszus@gmail.com>
26  * 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
27 * __Andrew Kroll__ - <xxxajk@gmail.com>
28  * Major contributor to mass storage code
29 * __guruthree__
30  * [Xbox ONE](#xbox-one-library) controller support
31 * __Yuuichi Akagawa__ - [\@YuuichiAkagawa](https://twitter.com/yuuichiakagawa)
32  * Developer of the [MIDI](#midi-library) library
33 
34 
35 # Table of Contents
36 
37 * [How to include the library](#how-to-include-the-library)
38  * [Arduino Library Manager](#arduino-library-manager)
39  * [Manual installation](#manual-installation)
40 * [How to use the library](#how-to-use-the-library)
41  * [Documentation](#documentation)
42  * [Enable debugging](#enable-debugging)
43  * [Boards](#boards)
44  * [Bluetooth libraries](#bluetooth-libraries)
45  * [BTHID library](#bthid-library)
46  * [SPP library](#spp-library)
47  * [PS4 Library](#ps4-library)
48  * [PS3 Library](#ps3-library)
49  * [Xbox Libraries](#xbox-libraries)
50  * [Xbox library](#xbox-library)
51  * [Xbox 360 Library](#xbox-360-library)
52  * [Xbox ONE Library](#xbox-one-library)
53  * [Xbox ONE S Library](#xbox-one-s-library)
54  * [Wii library](#wii-library)
55  * [PS Buzz Library](#ps-buzz-library)
56  * [HID Libraries](#hid-libraries)
57  * [MIDI Library](#midi-library)
58 * [Interface modifications](#interface-modifications)
59 * [FAQ](#faq)
60 
61 # How to include the library
62 
63 ### Arduino Library Manager
64 
65 First install Arduino IDE version 1.6.2 or newer, then simply use the Arduino Library Manager to install the library.
66 
67 Please see the following page for instructions: <http://www.arduino.cc/en/Guide/Libraries#toc3>.
68 
69 ### Manual installation
70 
71 First download the library by clicking on the following link: <https://github.com/felis/USB_Host_Shield_2.0/archive/master.zip>.
72 
73 Then uncompress the zip folder and rename the directory to "USB\_Host\_Shield\_20", as any special characters are not supported by the Arduino IDE.
74 
75 Now open up the Arduino IDE and open "File>Preferences". There you will see the location of your sketchbook. Open that directory and create a directory called "libraries" inside that directory.
76 Now move the "USB\_Host\_Shield\_20" directory to the "libraries" directory.
77 
78 The final structure should look like this:
79 
80 * Arduino/
81  * libraries/
82  * USB\_Host\_Shield\_20/
83 
84 Now quit the Arduino IDE and reopen it.
85 
86 Now you should be able to go open all the examples codes by navigating to "File>Examples>USB\_Host\_Shield\_20" and then select the example you will like to open.
87 
88 For more information visit the following sites: <http://arduino.cc/en/Guide/Libraries> and <https://learn.adafruit.com/adafruit-all-about-arduino-libraries-install-use>.
89 
90 # How to use the library
91 
92 ### Documentation
93 
94 Documentation for the library can be found at the following link: <https://felis.github.io/USB_Host_Shield_2.0/>.
95 
96 ### Enable debugging
97 
98 By default serial debugging is disabled. To turn it on simply change ```ENABLE_UHS_DEBUGGING``` to 1 in [settings.h](settings.h) like so:
99 
100 ```C++
101 #define ENABLE_UHS_DEBUGGING 1
102 ```
103 
104 ### Boards
105 
106 Currently the following boards are supported by the library:
107 
108 * All official Arduino AVR boards (Uno, Duemilanove, Mega, Mega 2560, Mega ADK, Leonardo etc.)
109 * Arduino Due, Intel Galileo, Intel Galileo 2, and Intel Edison
110  * 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 "Interface modifications" section in the [hardware manual](https://chome.nerpa.tech/usb-host-shield-hardware-manual) for more information.
111  * Note native USB host is not supported on any of these platforms. You will have to use the shield for now.
112 * Teensy (Teensy++ 1.0, Teensy 2.0, Teensy++ 2.0, Teensy 3.x, and Teensy LC)
113  * Note if you are using the Teensy 3.x you should download this SPI library as well: <https://github.com/xxxajk/spi4teensy3>. You should then add ```#include <spi4teensy3.h>``` to your .ino file.
114 * Balanduino
115 * Sanguino
116 * Black Widdow
117 * RedBearLab nRF51822
118 * Digilent chipKIT
119  * Please see: <https://chome.nerpa.tech/mcu/usb/running-usb-host-code-on-digilent-chipkit-board>.
120 * STM32F4
121  * 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: <https://github.com/Lauszus/Nucleo_F446RE_USBHost>.
122 * ESP8266 is supported using the [ESP8266 Arduino core](https://github.com/esp8266/Arduino)
123  * Note it uses pin 15 and 5 for SS and INT respectively
124  * Also please be aware that:
125  * GPIO16 is **NOT** usable, as it will be used for some other purposes. For example, reset the SoC itself from sleep mode.
126  * GPIO6 to 11 is also **NOT** usable, as they are used to connect SPI flash chip and it is used for storing the executable binary content.
127 * ESP32 is supported using the [arduino-esp32](https://github.com/espressif/arduino-esp32/)
128  * GPIO5 : SS, GPIO17 : INT, GPIO18 : SCK, GPIO19 : MISO, GPIO23 : MOSI
129 
130 The following boards need to be activated manually in [settings.h](settings.h):
131 
132 * Arduino Mega ADK
133  * If you are using Arduino 1.5.5 or newer there is no need to activate the Arduino Mega ADK manually
134 * Black Widdow
135 
136 Simply set the corresponding value to 1 instead of 0.
137 
138 ### [Bluetooth libraries](BTD.cpp)
139 
140 The [BTD library](BTD.cpp) is a general purpose library for an ordinary Bluetooth dongle.
141 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.
142 Some different examples can be found in the [example directory](examples/Bluetooth).
143 
144 The BTD library also makes it possible to use multiple services at once, the following example sketch is an example of this:
145 [PS3SPP.ino](examples/Bluetooth/PS3SPP/PS3SPP.ino).
146 
147 ### [BTHID library](BTHID.cpp)
148 
149 The [Bluetooth HID library](BTHID.cpp) allows you to connect HID devices via Bluetooth to the USB Host Shield.
150 
151 Currently HID mice and keyboards are supported.
152 
153 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.
154 
155 The [PS4 library](#ps4-library) also uses this class to handle all Bluetooth communication.
156 
157 For information see the following blog post: <http://blog.tkjelectronics.dk/2013/12/bluetooth-hid-devices-now-supported-by-the-usb-host-library/>.
158 
159 ### [SPP library](SPP.cpp)
160 
161 SPP stands for "Serial Port Profile" 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.
162 It has been tested successfully on Windows, Mac OS X, Linux, and Android.
163 
164 Take a look at the [SPP.ino](examples/Bluetooth/SPP/SPP.ino) example for more information.
165 
166 More information can be found at these blog posts:
167 
168 * <http://chome.nerpa.tech/mcu/bluetooth-rfcommspp-service-support-for-usb-host-2-0-library-released>
169 * <http://blog.tkjelectronics.dk/2012/07/rfcommspp-library-for-arduino/>
170 
171 To implement the SPP protocol I used a Bluetooth sniffing tool called [PacketLogger](http://www.tkjelectronics.com/uploads/PacketLogger.zip) developed by Apple.
172 It enables me to see the Bluetooth communication between my Mac and any device.
173 
174 ### PS4 Library
175 
176 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.
177 
178 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.
179 
180 Before you can use the PS4 controller via Bluetooth you will need to pair with it.
181 
182 Simply create the PS4BT instance like so: ```PS4BT PS4(&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.
183 
184 It should then automatically pair the dongle with your controller. This only have to be done once.
185 
186 For information see the following blog post: <http://blog.tkjelectronics.dk/2014/01/ps4-controller-now-supported-by-the-usb-host-library/>.
187 
188 Also check out this excellent Wiki by Frank Zhao about the PS4 controller: <http://eleccelerator.com/wiki/index.php?title=DualShock_4> and this Linux driver: <https://github.com/chrippa/ds4drv>.
189 
190 Several guides on how to use the PS4 library has been written by Dr. James E. Barger and are available at the following link: <https://sites.google.com/view/vbatc-engineeringtechnology2/control-system-tutorials/ps4-tutorials>.
191 
192 ### PS3 Library
193 
194 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.
195 
196 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.
197 
198 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.
199 
200 __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).
201 
202 For more information about the PS3 protocol see the official wiki: <https://github.com/felis/USB_Host_Shield_2.0/wiki/PS3-Information>.
203 
204 Also take a look at the blog posts:
205 
206 * <http://blog.tkjelectronics.dk/2012/01/ps3-controller-bt-library-for-arduino/>
207 * <http://chome.nerpa.tech/mcu/sony-ps3-controller-support-added-to-usb-host-library>
208 * <http://chome.nerpa.tech/mcu/arduino/interfacing-ps3-controllers-via-usb>
209 
210 A special thanks go to the following people:
211 
212 1. _Richard Ibbotson_ who made this excellent guide: <http://chome.nerpa.tech/mcu/ps3-and-wiimote-game-controllers-on-the-arduino-host-shield-part>
213 2. _Tomoyuki Tanaka_ for releasing his code for the Arduino USB Host shield connected to the wiimote: <http://chome.nerpa.tech/mcu/rc-car-controlled-by-wii-remote-on-arduino>
214 
215 Also a big thanks all the people behind these sites about the Motion controller:
216 
217 * <http://thp.io/2010/psmove/>
218 * <http://www.copenhagengamecollective.org/unimove/>
219 * <https://github.com/thp/psmoveapi>
220 * <http://code.google.com/p/moveonpc/>
221 
222 ### Xbox Libraries
223 
224 The library supports both the original Xbox controller via USB and the Xbox 360 controller both via USB and wirelessly.
225 
226 #### Xbox library
227 
228 The [XBOXOLD](XBOXOLD.cpp) class implements support for the original Xbox controller via USB.
229 
230 All the information are from the following sites:
231 
232 * <https://github.com/torvalds/linux/blob/master/Documentation/input/xpad.txt>
233 * <https://github.com/torvalds/linux/blob/master/drivers/input/joystick/xpad.c>
234 * <http://euc.jp/periphs/xbox-controller.ja.html>
235 * <https://github.com/Grumbel/xboxdrv/blob/master/PROTOCOL#L15>
236 
237 #### Xbox 360 Library
238 
239 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).
240 
241 To use it via USB use the [XBOXUSB](XBOXUSB.cpp) library or to use it wirelessly use the [XBOXRECV](XBOXRECV.cpp) library.
242 
243 __Note that a Wireless controller can NOT be used via USB!__
244 
245 Examples code can be found in the [examples directory](examples/Xbox).
246 
247 Also see the following blog posts:
248 
249 * <http://chome.nerpa.tech/mcu/xbox360-controller-support-added-to-usb-host-shield-2-0-library>
250 * <http://blog.tkjelectronics.dk/2012/07/xbox-360-controller-support-added-to-the-usb-host-library/>
251 * <http://blog.tkjelectronics.dk/2012/12/xbox-360-receiver-added-to-the-usb-host-library/>
252 
253 All the information regarding the Xbox 360 controller protocol are form these sites:
254 
255 * <http://tattiebogle.net/index.php/ProjectRoot/Xbox360Controller/UsbInfo>
256 * <http://tattiebogle.net/index.php/ProjectRoot/Xbox360Controller/WirelessUsbInfo>
257 * <https://github.com/Grumbel/xboxdrv/blob/master/PROTOCOL>
258 
259 #### Xbox ONE Library
260 
261 A 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:
262 
263 * <https://github.com/quantus/xbox-one-controller-protocol>
264 * <https://github.com/torvalds/linux/blob/master/drivers/input/joystick/xpad.c>
265 * <https://github.com/kylelemons/xbox/blob/master/xbox.go>
266 
267 #### Xbox ONE S Library
268 
269 A Xbox ONE controller is supported via Bluetooth in the [XBOXONESBT](XBOXONESBT.cpp) class.
270 
271 Special thanks to [HisashiKato](https://github.com/HisashiKato) for his help: <https://github.com/felis/USB_Host_Shield_2.0/issues/252#issuecomment-716912362>.
272 
273 ### [Wii library](Wii.cpp)
274 
275 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.
276 
277 First you have to pair with the controller, this is done automatically by the library if you create the instance like so:
278 
279 ```C++
280 WII Wii(&Btd, PAIR);
281 ```
282 
283 And then press 1 & 2 at once on the Wiimote or the SYNC buttons if you are using a Wii U Pro Controller or a Wii Balance Board.
284 
285 After that you can simply create the instance like so:
286 
287 ```C++
288 WII Wii(&Btd);
289 ```
290 
291 Then just press any button on the Wiimote and it will then connect to the dongle.
292 
293 Take a look at the example for more information: [Wii.ino](examples/Bluetooth/Wii/Wii.ino).
294 
295 Also take a look at the blog post:
296 
297 * <http://blog.tkjelectronics.dk/2012/08/wiimote-added-to-usb-host-library/>
298 
299 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).
300 
301 The [WiiIRCamera.ino](examples/Bluetooth/WiiIRCamera/WiiIRCamera.ino) example shows how it can be used.
302 
303 All the information about the Wii controllers are from these sites:
304 
305 * <http://wiibrew.org/wiki/Wiimote>
306 * <http://wiibrew.org/wiki/Wiimote/Extension_Controllers>
307 * <http://wiibrew.org/wiki/Wiimote/Extension_Controllers/Nunchuck>
308 * <http://wiibrew.org/wiki/Wiimote/Extension_Controllers/Wii_Motion_Plus>
309 * <http://wiibrew.org/wiki/Wii_Balance_Board>
310 * The old library created by _Tomoyuki Tanaka_: <https://github.com/moyuchin/WiiRemote_on_Arduino> also helped a lot.
311 
312 ### [PS Buzz Library](PSBuzz.cpp)
313 
314 This library implements support for the Playstation Buzz controllers via USB.
315 
316 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.
317 
318 The example [PSBuzz.ino](examples/PSBuzz/PSBuzz.ino) shows how one can do this with just a few lines of code.
319 
320 More information about the controller can be found at the following sites:
321 
322 * http://www.developerfusion.com/article/84338/making-usb-c-friendly/
323 * https://github.com/torvalds/linux/blob/master/drivers/hid/hid-sony.c
324 
325 ### HID Libraries
326 
327 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).
328 
329 ### [MIDI Library](usbh_midi.cpp)
330 
331 The library support MIDI devices.
332 You can convert USB MIDI keyboard to legacy serial MIDI.
333 
334 * [USB_MIDI_converter.ino](examples/USBH_MIDI/USB_MIDI_converter/USB_MIDI_converter.ino)
335 * [USB_MIDI_converter_multi.ino](examples/USBH_MIDI/USB_MIDI_converter_multi/USB_MIDI_converter_multi.ino)
336 
337 For information see the following page: <http://yuuichiakagawa.github.io/USBH_MIDI/>.
338 
339 # Interface modifications
340 
341 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.
342 
343 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!
344 
345 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.
346 
347 After that you need modify the following entry in [UsbCore.h](UsbCore.h):
348 
349 ```C++
350 typedef MAX3421e<P10, P9> MAX3421E;
351 ```
352 
353 For instance if you have rerouted SS to pin 7 it should read:
354 
355 ```C++
356 typedef MAX3421e<P7, P9> MAX3421E;
357 ```
358 
359 See the "Interface modifications" section in the [hardware manual](https://chome.nerpa.tech/usb-host-shield-hardware-manual) for more information.
360 
361 # FAQ
362 
363 > When I plug my device into the USB connector nothing happens?
364 
365 * Try to connect a external power supply to the Arduino - this solves the problem in most cases.
366 * You can also use a powered hub between the device and the USB Host Shield. You should then include the USB hub library: ```#include <usbhub.h>``` and create the instance like so: ```USBHub Hub1(&Usb);```.
367 
368 > When I connecting my PS3 controller I get a output like this:
369 
370 ```
371 Dualshock 3 Controller Enabled
372 
373 LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0
374 LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0
375 LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0
376 LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0
377 LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0
378 ```
379 
380 * 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.
381 
382 > When compiling I am getting the following error: "fatal error: SPI.h: No such file or directory".
383 
384 * Please make sure to include the SPI library like so: ```#include <SPI.h>``` in your .ino file.
Generated by   doxygen 1.8.11