1
0
mirror of https://github.com/mcgurk/Arduino-USB-HID-RetroJoystickAdapter synced 2024-11-14 05:05:01 -05:00
Arduino-USB-HID-RetroJoysti.../README.md

253 lines
15 KiB
Markdown
Raw Normal View History

2016-09-05 15:33:10 -04:00
# Arduino-USB-HID-RetroJoystickAdapter
2016-09-05 17:12:48 -04:00
## What is this?
2016-09-06 02:47:09 -04:00
Very cheap and quite easy way to connect many non-USB joysticks and gamepads or DIY arcade cabinet controller to almost any machine with USB-port and HID-support. Arduino board with ATmega32u4 chip with help of Joystick-library does all the USB-work.
2016-09-11 14:38:11 -04:00
Tested with Windows and Linux desktop computers and ARM based computers like Raspberry Pi and Orange Pi.
2016-09-05 17:15:38 -04:00
2016-09-11 14:38:11 -04:00
ATmega32u4 can be easily changed to act as keyboard and/or mouse too. With keyboard device it is easy to make adapter for many mobile devices which don't have gamepad-support out of box. I have tested it with Samsung Galaxy S4 Android phone and Samsung Galaxy Tab 10.1 Android tablet with OTG-USB cable.
2016-09-05 15:33:10 -04:00
2016-09-07 14:51:23 -04:00
### Supported controllers
2016-10-07 11:32:15 -04:00
- Atari-joysticks (supports Sega Master System controller with 2-fire buttons) (ATARI) ²
- Nintendo Entertainment System controllers (NES) ²
- Super Nintendo controllers (SNES) ²
- Sony Playstation 1/2 controllers (doesn't support Dualshock or analog features) (PSX) ²
2016-10-16 10:18:10 -04:00
- Sega Genesis / Megadrive controllers (3 and 6-button versions) (RetroJoystickAdapter_Megadrive.ino) ² \*
2016-10-07 11:32:15 -04:00
- Nintendo 64 controller (RetroJoystickAdapter_N64.ino) (3.3V!)
2016-10-09 15:15:04 -04:00
- Sony Playstation with Analog and Multitap 4 controllers support (RetroJoystickAdapter_Playstation.ino) \*
2016-11-11 11:14:10 -05:00
- Wii Nunchuck and Classic Controller (and maybe Pro, not tested) (RetroJoystickAdapter_WiiExtension.ino) (3.3V!) \*
2016-11-11 05:52:16 -05:00
- [AT and PS/2 Keyboard](https://github.com/mcgurk/Arduino-USB-HID-RetroJoystickAdapter/tree/master/Keyboard_PS2)
2016-10-07 11:32:15 -04:00
² = 2 controllers supported
2016-10-09 15:15:04 -04:00
\* = doesn't need Joystick-library
2016-09-07 14:51:23 -04:00
2016-10-07 11:48:33 -04:00
If you use Linux and want to get more than 1 controller with one Arduino, check "Linux and more than one controller with one Arduino"-topic in this same page.
2016-10-07 11:39:39 -04:00
2016-09-05 17:05:10 -04:00
## Short version
2016-09-06 09:11:24 -04:00
- Get ATmega32u4 Arduino board
2016-09-06 02:39:46 -04:00
- Connect joystick or gamepad to Arduino (in most situations soldering is required)
2016-09-22 17:47:14 -04:00
- Install Arduino [IDE](https://www.arduino.cc/en/Main/Software)
2016-09-08 14:33:42 -04:00
- Install Joystick [library](https://github.com/MHeironimus/ArduinoJoystickLibrary)
2016-09-05 17:31:28 -04:00
- Open sourcecode to Arduino IDE and select controller by commenting and uncommenting and edit pin-numbers (if needed)
2016-09-05 17:05:54 -04:00
- Upload
2016-09-05 17:17:09 -04:00
- Done
2016-09-05 17:05:10 -04:00
2016-09-05 17:06:41 -04:00
## Long version
2016-09-05 17:07:25 -04:00
### What you need
2016-09-05 15:35:25 -04:00
2016-09-05 17:07:25 -04:00
#### Arduino board
2016-09-21 04:09:04 -04:00
Starting point is ATmega32u4 based Arduino board. There is two versions of ATmega32u4, IO-logic with 5V or 3.3V. Many controllers (like basic Atari-controller) doesn't include any logic, so 5V and 3.3V versions are fine. Most of controllers with some logic needs 5V (NES, SNES, Genesis) and some rare ones needs 3.3V (N64/Gamecube) (5V is 16MHz and 3.3V 8MHz, so timings are different and 16MHz code doesn't work for N64/Gamecube with 3.3V version). Make sure that Arduino includes USB-port. There are some versions which doesn't include USB-port and then you have to add USB-connector for it. Arduino Leonardo includes ATmega32u4, but cheapest and smallest ones are named Pro Micro. Arduino Pro Micro and ATmega32u4 are good words to use when searching from Ebay etc. Cheapest starts from about $4.
2016-09-05 15:55:34 -04:00
2016-09-05 16:28:24 -04:00
Example of Arduino Pro Micro:
2016-09-06 05:57:36 -04:00
![Arduino Pro Micro](https://github.com/mcgurk/Arduino-USB-HID-RetroJoystickAdapter/raw/master/Images/Arduino_ProMicro.jpg)
2016-09-05 16:28:24 -04:00
2016-09-05 17:07:25 -04:00
#### Computer with Arduino IDE
2016-09-05 16:50:00 -04:00
Arduino IDE works with Windows, OS X and Linux and ARM (beta). If you use small card computer like Rasperry Pi or Orange Pi, you can program adapter even with them (tested with Orange Pi PC and RetrOrangePi 2.0). That way you don't even have to unplug adapter from your emulator/game-platform if you want reprogram adapter.
2016-09-05 16:17:51 -04:00
2016-09-05 17:07:25 -04:00
#### Joystick library for Arduino IDE
2016-09-05 15:35:25 -04:00
https://github.com/MHeironimus/ArduinoJoystickLibrary
2016-09-05 15:48:48 -04:00
2016-09-05 17:07:25 -04:00
#### Joystick(s) or gamepad(s) and way to connect them to Arduino
2016-09-05 16:31:45 -04:00
Some joystick/gamepads uses their own connectors and original connectors can be very pricey. Sometimes you can find extension cord cheaper than plain connector and you can take cable and plug from that.
2016-09-05 16:58:26 -04:00
You can use any IO-pins, but try to avoid pins 0 and 1. They are serial port TX and RX pins and even though they are not used right now, they are handy for debugging and other uses.
2016-09-08 14:56:27 -04:00
Example in [Hardware](https://github.com/mcgurk/Arduino-USB-HID-RetroJoystickAdapter/tree/master/Hardware) folder.
2016-09-05 15:48:48 -04:00
2016-09-22 13:53:36 -04:00
Example of NES-controller wiring:
2016-09-22 13:53:58 -04:00
2016-09-22 13:53:36 -04:00
![NES wiring](https://github.com/mcgurk/Arduino-USB-HID-RetroJoystickAdapter/raw/master/Hardware/nes.png)
2016-09-05 17:07:25 -04:00
### Setup
2016-09-05 16:28:24 -04:00
2016-09-06 02:45:18 -04:00
- Download and install Arduino IDE: https://www.arduino.cc/en/Main/Software
2016-09-05 16:28:24 -04:00
2016-11-15 07:16:17 -05:00
- Prepare `C:\Program Files (x86)\Arduino\hardware\arduino\avr\boards.txt` or in linux `arduino-x.x.xx/hardware/arduino/avr/boards.txt` (close Arduino IDE before editing):
2016-11-15 06:52:32 -05:00
```
# leonardo.build.vid=0x2341
# leonardo.build.pid=0x8036
leonardo.build.vid=0x8282
leonardo.build.pid=0x3201
# leonardo.build.usb_product="Arduino Leonardo"
leonardo.build.usb_product="Retro Joystick Adapter"
```
2016-09-06 07:12:16 -04:00
- `Tools->Board->Arduino Leonardo`
2016-09-05 17:25:40 -04:00
2016-11-13 18:34:53 -05:00
In Arduino IDE you have to select board. In my case some reason "Arduino Leonardo" selections works better than "Arduino/Genuino Micro". With Leonardo-setting RX and TX leds are normally off and blinks when data is transfered to/from USB. With Micro-setting LED's are normally on and they blinks to off when data is transferring. Connect now your board ATmega32u4 through USB, the RX and TX leds should blink (if not, try another USB port).
2016-09-05 16:44:57 -04:00
2016-09-06 07:12:16 -04:00
- `Tools->Port->COMx`
2016-09-05 17:25:40 -04:00
2016-11-13 18:34:53 -05:00
Arduino IDE shows available COM-ports. In most cases it's biggest numbered COM-port. COM-port number can change when you start to upload program first time (COM-port number can be different after joystick-features are enabled). If this happens, just change COM-port and start upload again. When I tested with RetrOrangePi (Armbian Linux), port was `/dev/ttyACM0`. In Windows envoirement, do not use any USB HUB, it may interfere whit the comunication whit ATmega32u4 board.
2016-09-05 16:44:57 -04:00
2016-09-05 17:26:15 -04:00
- Test your programming environment and upload
2016-09-06 07:12:47 -04:00
You can now test your setup. One basic example is "blink". With this board, it doesn't blink, because there is no led in pin 13. Nevertheless you can use it as a test that your IDE and Arduino works. Select `File -> Examples -> 01.Basics -> Blink` and press `Upload` (Arrow to right -symbol top of code windows). If you get no errors, you are good to go.
2016-09-05 17:24:43 -04:00
2016-09-06 02:34:21 -04:00
- Install joystick library
2016-09-06 07:12:16 -04:00
Go to https://github.com/MHeironimus/ArduinoJoystickLibrary and press `Clone or download -> Download ZIP`.
2016-09-06 06:11:27 -04:00
Extract Joystick2 folder from zip to `%HOMEPATH%\Documents\Arduino\libraries` (Windows) or `~/Arduino/libraries` (Linux).
2016-09-06 07:10:33 -04:00
After extraction check that you have files `%HOMEPATH%\Documents\Arduino\libraries\Joystick2\Joystick2.h and Joystick2.cpp` or `~/Arduino/libraries/Joystick2/Joystick2.h and Joystick2.cpp`.
2016-09-06 06:07:20 -04:00
Close and start Arduino IDE again so it searches and finds library.
2016-09-05 16:28:24 -04:00
2016-09-09 07:07:46 -04:00
Playstation analog controller `RetroJoystickAdapter_PlaystationAnalog.ino` needs `Joystick\Joystick.h` and `Joystick\Joystick.cpp`.
2016-09-09 07:05:41 -04:00
2016-09-09 07:07:46 -04:00
- Load `RetroJoystickAdapter.ino` to Arduino IDE
2016-09-06 03:16:00 -04:00
2016-09-06 06:08:15 -04:00
Select controller by commenting and uncommenting and edit pin-numbers (if needed).
2016-09-06 03:16:00 -04:00
- Press Upload
2016-11-15 05:37:10 -05:00
- If you got the message "all done" and no errors, your done here.
### Time to Enjoy
#### MS Windows
2016-11-15 05:42:20 -05:00
- You should go now to `Control Panel -> All Control Panel Items > Devices and Printers (some Windows versions in Game Controllers)` and try to find `Arduino Leonardo` device. Right click on `Gamepad controller definitions` > double click in one of the options (1st is the controller one, and the 2nd is the controller two) and you can now test the buttons.
2016-11-15 05:37:10 -05:00
#### Linux
- Just connect, open your command line and test whit `jstest /dev/input/js0`.
2016-09-06 03:16:00 -04:00
2016-11-15 06:35:20 -05:00
2016-11-15 07:03:44 -05:00
### Code
Select your controller by commenting and uncommenting stuff from beginning of source code and give your IO-pin numbers.
Every one uses same button numbering, so if you make multiple adapters for different controllers, you have to teach buttons to emulator/game (or whole emulation system like RetroPie or RetrOrangePi) only once.
#### Konami code
You can also enable or disable Konami-code-shortcut. For now it works only with Genesis 6-button controller (X+Y+Z+UP (or DOWN)), SNES-controller (X+Y+R1+UP (or DOWN)) and PSX-controller (rectangle+circle+triangle+UP (or DOWN)). "UP"-version is normal and "DOWN"-version swaps A and B. Some games demands that not other buttons are pressed before code and that's why only last pressed button can be button which have some function in emulator.
https://en.wikipedia.org/wiki/Konami_Code
https://en.wikipedia.org/wiki/List_of_Konami_code_games
2016-11-15 06:35:20 -05:00
2016-11-15 07:03:44 -05:00
## Tutorial
There is simple tutorial in [Tutorial](https://github.com/mcgurk/Arduino-USB-HID-RetroJoystickAdapter/tree/master/Tutorial) folder. I tried to make it as clear as possible, so even if you are not familiar with coding, you may can do modifications to it (example add a button).
## Misc
2016-11-15 06:35:20 -05:00
2016-11-15 07:03:44 -05:00
### Using Arduino Leonardo in Windows with Arduino Leonardo VID/PID
2016-11-15 07:04:32 -05:00
On any other MS Windows platforms you may have to install the arduino drivers. To have the last updated ones, just download the file `Windows ZIP file for non admin install` from the page https://www.arduino.cc/en/Main/Software. After the download, unzip the folder. Go to the `Computer` > right click > `Manage > Unknown devices` > right click > `Update software controller > Find on my computer > Search` > and try to find the folder `\arduino-1.6.xx\drivers` inside the folder you unziped before. Click `Next` and Windows should install the driver. Arduino would apper as the name `Arduino Leonardo` inside `Ports (COM and LPT)` with an associated COM port (like `COM9` for example).
2016-11-15 07:03:44 -05:00
### Using Arduino Leonardo in Linux with Arduino Leonardo VID/PID
2016-10-10 04:47:57 -04:00
Linux usbhid-module doesn't support out of box multiple controllers with one USB without USB-hub-features (I'm not sure about this, but I didn't manage to get multiple /dev/js-devices without this).
You have to give parameter
2016-10-10 04:49:59 -04:00
`quirks=0x2341:0x8036:0x40` (first numbers are VID and PID of Arduino) to usbhid-module. Here is example how to do it with RetrOrangePi 2.5.2:
2016-10-07 11:40:47 -04:00
- Make backup of `/boot/boot-retro.cmd` and `/boot/boot.scr`
- Edit `/boot/boot-retro.cmd` setenv bootargs -line and add `usbhid.quirks=0x2341:0x8036:0x40` to kernel parameters.
- `sudo mkimage -C none -A arm -T script -d /boot/boot-retro.cmd /boot/boot.scr`
2016-10-07 11:43:18 -04:00
- Reboot
2016-10-17 17:15:59 -04:00
- Check with `cat /proc/cmdline`
2016-10-07 11:39:39 -04:00
2016-11-15 07:09:15 -05:00
### What are VID/PID numbers in boards.txt?
2016-11-15 07:03:44 -05:00
Linux problem with multiple controllers are solved with changing VID and PID to something that already has HID_QUIRK_MULTI_INPUT (0x40) activated in kernel.
2016-10-10 04:47:14 -04:00
Here you can see what quirks are activated to different VID/PIDs:
https://github.com/torvalds/linux/blob/master/drivers/hid/usbhid/hid-quirks.c
2016-11-15 07:03:44 -05:00
In these instructions, USB_VENDOR_ID_MOJO 0x8282, USB_DEVICE_ID_RETRO_ADAPTER 0x3201 are used.
2016-09-05 16:06:27 -04:00
2016-11-15 07:03:44 -05:00
### Changing number of buttons in joystick-library
2016-10-10 04:52:32 -04:00
If you want that less than 16 buttons are shown in joystick-settings, edit Joystick.cpp/Joystick2.cpp/Joystick3.cpp "USAGE_MAXIMUM"-line (0x10 = 16). You may to have create new project after that, because all libraries are not recompiled every time and I don't know how to force full recompile.
2016-10-05 14:50:11 -04:00
2016-11-15 07:03:44 -05:00
### Menu for multiple adapter names
2016-10-10 04:51:42 -04:00
Adapter shows as "Arduino Leonardo", but if you want it to show some other name, edit `C:\Program Files (x86)\Arduino\hardware\arduino\avr\boards.txt`. You can even add sub menu to tools-menu by adding these lines (after editing boards.txt, you have to close and reopen Arduino IDE):
2016-10-05 14:50:11 -04:00
```
menu.usb_name=USB Product Name
leonardo.menu.usb_name.leonardo="Leonardo"
leonardo.menu.usb_name.leonardo.build.usb_product="Arduino Leonardo"
leonardo.menu.usb_name.leonardo_1="Genesis 6"
leonardo.menu.usb_name.leonardo_1.build.usb_product="Genesis 6-button adapter"
leonardo.menu.usb_name.leonardo_2="Genesis 3"
leonardo.menu.usb_name.leonardo_2.build.usb_product="Genesis 3-button adapter"
leonardo.menu.usb_name.leonardo_3="NES"
leonardo.menu.usb_name.leonardo_3.build.usb_product="NES-adapter"
leonardo.menu.usb_name.leonardo_4="SNES"
leonardo.menu.usb_name.leonardo_4.build.usb_product="SNES-adapter"
```
2016-09-14 04:59:15 -04:00
### Arduino Uno R3
2016-09-05 17:16:35 -04:00
Arduino UNO R3 includes ATmega16u2 (along with ATmega328p) and it can be used too, but it needs some extra work (code doesn't work without modifications with UNO):
2016-09-05 15:48:48 -04:00
https://github.com/NicoHood/HoodLoader2
2016-09-05 17:55:04 -04:00
2016-09-21 05:01:54 -04:00
### Software USB
USB-device without ATmega16u2/32u4. Needs 3 resistors and 2 zener diodes.
https://www.obdev.at/products/vusb/index.html
2016-09-14 04:59:15 -04:00
### PS/2
2016-09-14 04:57:42 -04:00
PS/2-keyboard can be connected directly to Arduino and there is library for that.
2016-09-14 04:58:16 -04:00
2016-09-14 04:57:42 -04:00
http://playground.arduino.cc/Main/PS2Keyboard
2016-09-14 04:59:15 -04:00
### USB host
2016-09-14 04:58:16 -04:00
You can also use Arduino vice versa. You cannot read USB with normal Arduino, but there is shields to make Arduino as USB host. With that you can connect modern USB-joysticks and gamepads to old consoles.
2016-09-14 04:57:42 -04:00
https://github.com/felis/USB_Host_Shield_2.0
2016-11-11 12:25:46 -05:00
### Level shifting and voltage levels
#### Converter
2016-10-20 05:01:57 -04:00
Very handy level converter with 3.3V AMS1117 regulator. Search from Ebay with `Logic Level Converter Module AMS1117 DC 5V to 3.3V`
![Level converter with AMS1117](https://raw.githubusercontent.com/mcgurk/Arduino-USB-HID-RetroJoystickAdapter/master/Images/Levelconverter_with_AMS1117.jpg)
2016-11-11 12:25:46 -05:00
#### Playstation, 3.3V, 3.7V or 5V?
2016-10-18 16:45:26 -04:00
There is contradictory data about Playstation controller voltages. I have one commercial adapter and it's 5V. I haven't measured official Playstation, but it is probably 3.3V.
2016-10-07 07:06:08 -04:00
2016-11-11 12:25:46 -05:00
#### Wii extension controllers
2016-11-11 12:28:10 -05:00
Wii extensions are 3.3V, but I have used Wii Nunchuck and Classic Controller with 5V (VCC and signals) without problems.
2016-11-11 12:24:28 -05:00
2016-09-14 04:59:52 -04:00
### Other ideas
2016-09-11 14:45:24 -04:00
Of course Arduino can be used many other ways. Add a PIR motion detector module from Ebay (under $2) and your computer wakes up from sleep when you walk to room. Just read PIR-sensor data pin and if it is 1, send some keyboard button (which normally does nothing) to computer so it wakes up. Or make info-board to your kitchen or hallway wall from old Android tablet and it turns on backlight only when someone goes to kitchen.
2016-09-20 04:33:04 -04:00
## Links
2016-09-22 14:04:32 -04:00
#### Arduino
2016-09-22 13:57:32 -04:00
http://playground.arduino.cc/Main/InterfacingWithHardware
2016-09-20 04:33:04 -04:00
#### NES
http://www.mit.edu/~tarvizo/nes-controller.html
2016-09-20 04:37:25 -04:00
#### SNES
http://wiki.superfamicom.org/snes/show/Schematics,+Ports,+and+Pinouts
2016-09-20 04:39:02 -04:00
https://github.com/burks10/Arduino-SNES-Controller
2016-09-20 04:33:04 -04:00
#### Sega Megadrive / Genesis
https://www.cs.cmu.edu/~chuck/infopg/segasix.txt
2016-09-20 04:40:13 -04:00
2016-09-20 04:40:02 -04:00
https://jonthysell.com/2014/07/26/reading-sega-genesis-controllers-with-arduino/
2016-09-20 04:33:04 -04:00
#### Playstation
http://www.gamesx.com/controldata/psxcont/psxcont.htm
2016-09-20 04:40:36 -04:00
http://playground.arduino.cc/Main/PSXLibrary
2016-10-06 04:54:56 -04:00
http://problemkaputt.de/psx-spx.htm#controllersandmemorycards
2016-10-06 03:56:34 -04:00
2016-09-20 04:33:04 -04:00
#### Playstation Dualshock:
https://gist.github.com/scanlime/5042071
#### Nintendo 64 / Gamecube:
https://github.com/NicoHood/Nintendo
https://github.com/brownan/Gamecube-N64-Controller
2016-10-09 17:32:24 -04:00
#### Wii Classic Controller:
https://github.com/robotgeek/WiiClassy
http://wiibrew.org/wiki/Wiimote/Extension_Controllers/Classic_Controller
2016-10-19 18:02:44 -04:00
#### Gamecube / N64
http://www.int03.co.uk/crema/hardware/gamecube/gc-control.htm
https://github.com/NicoHood/Nintendo/wiki/Gamecube