Introduction: Arduino Leonardo/Micro As Game Controller/Joystick
IMPORTANT NOTE: This article is for Arduino IDE version 1.6.6 (or above). To add a USB Game Controller to an Arduino Leonardo or Micro using Arduino IDE version 1.6.5 (or below) see the following Instructable: Add USB Game Controller to Arduino Leonardo/Micro.
Out of the box the Arduino Leonardo and the Arduino Micro appear to the host computer as a generic keyboard and mouse. This article discusses how the Arduino Leonardo and the Arduino Micro can also appear as a generic Game Controller or Joystick. This project will only work with Arduino products based on the ATmega32u4 microcontroller (i.e. the Arduino Leonardo and the Arduino Micro). It will not work with the Arduino UNO, because it is based on the ATmega328 microcontroller.
The Arduino Joystick Library (a.k.a. Game Controller library) used in the Instructable provides the following:
- X, Y, and Z axis
- 32 buttons
- X, Y, and Z axis rotation
- 2 Point of View Hat Switches
Step 1: Installing the Library
The latest version of the Arduino library that allows the Arduino Leonardo and Micro to appear as a Game Controller can be downloaded from the following GitHub repository:
This GitHub repository actually contains three different versions of the Arduino Joystick Library:
- Joystick - Causes the Arduino to appear as single Game Controller
- Joystick2 - Causes the Arduino to appear as two, simple Game Controllers
- Joystick3 - Causes the Arduino to appear as three, simple Game Controllers
Copy the Joystick (and/or Joystick2 and/or Joystick3) folder from GitHub to the Arduino Libraries folder (typically located at %userprofile%\Documents\Arduino\libraries). The library (or libraries) should now appear in the Arduino IDE list of libraries.
Step 2: Running the Test Sketch
Included in the library is a test sketch, called UsbJoystickTest.ino (or UsbJoystick2Test.ino or UsbJoystick3Test.ino). This sketch should be loaded, compiled, and uploaded to the Arduino Leonardo or Micro using the Arduino IDE (version 1.6.6 or above).
The following steps are for Windows 7. If you have a different version of Windows or a different operating system, these steps may differ.
Step 3: Windows Control Panel - Hardware and Sound
Go to the Windows Control Panel and select “Hardware and Sound”.
Step 4: Devices and Printers
Then select “Devices and Printers”.
Step 5: Arduino Settings
- The Arduino Micro or Arduino Leonardo should appear in the list of devices.
- Right mouse click on the Arduino Leonardo or Arduino Micro to display the settings menu.
- Select “Game controller settings” to get to the “Game Controllers” dialog.
Step 6: Game Controller Settings
The Arduino Leonardo or Micro should appear in the list of installed game controllers. Select the Arduino Leonardo or Micro and click the Properties button to display the game controller test dialog.
Step 7: Test Using Game Controller Settings
While this dialog has focus, ground pin A0 on the Arduino to activate the test script. The test script will test the game controller functionality in the following order:
- 32 buttons
- throttle and rudder
- X and Y Axis
- Z Axis
- 2 Hat Switches
- X and Y Axis Rotation
Step 8: Another Simple Test
Once you have verified the Arduino Leonardo or Micro is working as a Game Controller, you can start creating your own Game Controller projects. The attached Arduino sketch file is a simple example that reads digital pins 9, 10, 11, and 12 and maps them to buttons 1, 2, 3, and 4 on the Game Controller.
Step 9: Joystick Library API
Now that the Joystick library is available to the Arduino IDE, an Arduino Leonardo or Arduino Micro can be used for custom game controller projects. The following describes the complete Arduino Joystick Library API.
Starts emulating a game controller connected to a computer. By default all methods update the game controller state immediately. If initAutoSendState is set to false, the Joystick.sendState method must be called to update the game controller state.
Stops the game controller emulation to a connected computer.
Sets the X axis value. Range -127 to 127 (0 is center).
Sets the Y axis value. Range -127 to 127 (0 is center).
Sets the Z axis value. Range -127 to 127 (0 is center).
Sets the X axis rotation value. Range 0° to 360°.
Sets the Y axis rotation value. Range 0° to 360°.
Sets the Z axis rotation value. Range 0° to 360°.
Joystick.setButton(byte button, byte value)
Sets the state (0 or 1) of the specified button (0 - 31). The button is the 0-based button number (i.e. button #1 is 0, button #2 is 1, etc.). The value is 1 if the button is pressed and 0 if the button is released.
Press the indicated button (0 - 31). The button is the 0-based button number (i.e. button #1 is 0, button #2 is 1, etc.).
Release the indicated button (0 - 31). The button is the 0-based button number (i.e. button #1 is 0, button #2 is 1, etc.).
Sets the throttle value. Range 0 to 255.
Sets the rudder value. Range 0 to 255.
Joystick.setHatSwitch(byte hatSwitch, int value)
Sets the value of the specified hat switch. The hatSwitch is 0-based (i.e. hat switch #1 is 0 and hat switch #2 is 1). The value is from 0° to 360°, but in 45° increments. Any value less than 45° will be rounded down (i.e. 44° is rounded down to 0°, 89° is rounded down to 45°, etc.). Set the value to -1 to release the hat switch.
Sends the updated joystick state to the host computer. Only needs to be called if AutoSendState is false (see Joystick.begin for more details).
Step 10: Additional Information
Additional information about this Arduino Joystick Library can be found on the following websites:
Arduino Joystick Library - http://mheironimus.blogspot.com/2015/11/arduino-joystick-library.html
GitHub [MHeironimus/ArduinoJoystickLibrary] - https://github.com/MHeironimus/ArduinoJoystickLibrary
We have a be nice policy.
Please be positive and constructive.
How id the Joystick hooked up to an Arduino Leonardo I can t get it to work I don't know which ports to plug the serial joystick into
I am sorry, but I am not sure I know what you mean by serial joystick. The Arduino pins you use are up to you. In your sketch for you will read values from the pins and make calls to the library. The library will then communicate that information to the host PC. I recommend looking at the following https://www.instructables.com/id/Create-a-Joystick-Using-the-Arduino-Joystick-Libra/
Hi! nice job, I try to build a joy with Arduino UNO, and have a problem with the calibration, when xplane run popup message appear saying "new usb joystick and need to calibrate.." allways :(. In this proyect the calibration data is stored? It would not work for me if the calibration can not be saved. Thanks!!!
What Operating System is running on the computer you are using?
Joystick calibration is something the OS is doing (or maybe the program that is using the joystick), not something the Arduino is doing.