loading

IMPORTANT NOTE: This article is for Arduino IDE version 1.6.5 (or below). To add a USB Game Controller to an Arduino Leonardo or Micro using Arduino IDE version 1.6.6 (or above) see the following Instructable: Arduino Leonardo/Micro as Game Controller/Joystick.

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. 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 generic Game Controller provides the following:

  • X, Y, and Z axis
  • 32 buttons
  • X, Y, and Z axis rotation
  • Rudder
  • Throttle
  • 2 Point of View Hat Switches

Step 1: Updating the Arduino Code

First make a backup copy of the following two files in the “%PROGRAMFILES%\Arduino\hardware\arduino\avr\cores\arduino” folder:

  • USBAPI.h
  • HID.cpp

Replace these two files with the ones attached to add a generic Game Controller to the Arduino Leonardo and the Arduino Micro.

Step 2: Running the Test Sketch

Compile and upload the attached UsbJoystickTest.ino sketch file onto the Arduino Leonardo or the Arduino Micro using the Arduino Software (IDE). I have tested this using version 1.6.1 through 1.6.5 of the software. For Arduino IDE version 1.6.6 and above, see the following Instructable: Arduino Leonardo/Micro as Game Controller/Joystick.

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 Should Appear

The Arduino Micro or Arduino Leonardo should appear in the list of devices.

Step 6: Arduino Settings

  • Next right mouse click on the Arduino Leonardo or Arduino Micro to display the settings menu.
  • Then select “Game controller settings” to get to the “Game Controllers” dialog.

Step 7: Game Controller Settings

The Arduino Micro or Arduino Leonardo should appear in the list of installed game controllers. Select the Arduino Micro or Arduino Leonardo and click the Properties button to display the game controller test dialog.

Step 8:

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 9: Joystick Library

Now that the Arduino Leonardo or Arduino Micro has the Joystick library, the Arduino can be used for custom game controller projects. The following describes the Joystick library that is included in the updated USBAPI.h and HID.cpp files.

Joystick.begin(bool initAutoSendState)

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.

Joystick.end()

Stops the game controller emulation to a connected computer.

Joystick.setXAxis(byte value)

Sets the X axis value. Range -127 to 127 (0 is center).

Joystick.setYAxis(byte value)

Sets the Y axis value. Range -127 to 127 (0 is center).

Joystick.setZAxis(byte value)

Sets the Z axis value. Range -127 to 127 (0 is center).

Joystick.setXAxisRotation(int value)

Sets the X axis rotation value. Range 0° to 360°.

Joystick.setyAxisRotation(int value)

Sets the Y axis rotation value. Range 0° to 360°.

Joystick.setZAxisRotation(int value)

Sets the Z axis rotation value. Range 0° to 360°.

Joystick.setButton(byte button, byte value)

Sets the state of the specified button. 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.

Joystick.pressButton(byte button)

Press the indicated button. The button is the 0-based button number (i.e. button #1 is 0, button #2 is 1, etc.).

Joystick.releaseButton(byte button)

Release the indicated button. The button is the 0-based button number (i.e. button #1 is 0, button #2 is 1, etc.).

Joystick.setThrottle(byte value)

Sets the throttle value. Range 0 to 255.

Joystick.setRudder(byte value)

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.).

Joystick.sendState()

Sends the updated joystick state to the host computer. Only needs to be called if AutoSendState is false (see Joystick.begin for more details).

<p>hi all,<br>just figure out the code i need for the joystick i need finally.<br></p><p>with 1 analog and 9 button mini joystick for my retropie.</p><p>i'm new in arduino, and not good in coding, just curious if any better way to do this.<br>btw, it's interest for try and error in coding arduino ;)</p><p>here is the code just modify by web research:</p><p>#include &lt;Joystick.h&gt;</p><p>Joystick_ Joystick(0x03, 0x04, 9, 0, true, true, false, false, false, false, false, false, false, false, false);</p><p>void setup() {</p><p>pinMode(2, INPUT_PULLUP); //A</p><p>pinMode(3, INPUT_PULLUP); //B</p><p>pinMode(4, INPUT_PULLUP); //X</p><p>pinMode(5, INPUT_PULLUP); //Y</p><p>pinMode(6, INPUT_PULLUP); //L</p><p>pinMode(7, INPUT_PULLUP); //R</p><p>pinMode(8, INPUT_PULLUP); //SELET</p><p>pinMode(9, INPUT_PULLUP); //START</p><p>pinMode(10, INPUT_PULLUP); //EXIT</p><p>Joystick.setXAxisRange(-32767,32767);</p><p>Joystick.setYAxisRange(-32767,32767);</p><p>Joystick.begin();</p><p>}</p><p>const int pinToButtonMap = 2;</p><p>int lastButtonState[9] = {0,0,0,0,0,0,0,0,0};</p><p>void loop(){</p><p>int xAxis = analogRead(A0);</p><p>int yAxis = analogRead(A1);</p><p>xAxis = map(xAxis, 1023, 0, 0, 255);</p><p>yAxis = map(yAxis, 0, 1023, 0, 255);</p><p>Joystick.setXAxis(xAxis);</p><p>Joystick.setYAxis(yAxis);</p><p>for (int index = 0; index &lt; 9; index++)</p><p>{</p><p>int currentButtonState = !digitalRead(index + pinToButtonMap);</p><p>if (currentButtonState != lastButtonState[index])</p><p>{</p><p>Joystick.setButton(index, currentButtonState);</p><p>lastButtonState[index] = currentButtonState;</p><p>}</p><p>}</p><p>}</p>
<p>Hi, is possible with this create a force feedback Sterring Wheel??? And witch board i can use??</p>
<p>I think this library could be used as a starting point, but I have not researched this. This library currently only supports sending Joystick data to the host machine. Force feedback devices get data back from the host computer and act on it (e.g. making the steering wheel harder to turn).</p><p>The library I wrote should work with any ATmega32u4 - based Arduino (or clone). I have tested it with the Arduino Leonardo and Arduino Micro. I know of others who have used it with the Arduino Due and SparkFun Pro Micro. I know it will not work with the Arduino Uno (since it used the ATmega328P).</p>
<p>Thank for your response.. </p><p>I will try to go on this direction, if you have other info about it let us know them! I know that a lot of people have the same problem! </p>
<p>I was build it, and works with Arduino Due.<br>Thank you!<br>It works with TrainSimulator 2016 very well!</p>
<p>Glad it worked for you. Thanks for letting me know what Arduino you used.</p>
<p>Great library and very useful. However I have been experiencing the issue where I cannot use both the Joystick.h and either/both Mouse.h and Keyboard.h. It seems the arduino can't be recognized as both a game controller and an HID device. Is there any workaround that you know of?</p>
<p>Can you include an example sketch file (*.ino) that demonstrates your issue? I have successfully used Joystick.h and Keyboard.h together without issue (see <a href="https://www.instructables.com/id/Ultimate-Classic-Game-Console-Joystick-to-USB-Adap/" rel="nofollow">https://www.instructables.com/id/Ultimate-Classic-Game-Console-Joystick-to-USB-Adap/</a> for an example of this).</p>
<p>Thanks for the response! I actually got them to work together by installing the Joystick Libraries in the Program Files folder, not in the Documents/Arduino folder. The past day has been very productive thanks to your code. Thanks!</p>
<p>I am glad to hear you got it working.</p>
<p>i no understand ino file anythink, how working ?????</p><p>how add all my switch to ino and how read and write ???? only need all toggle/button at my flight sim panel, start,run,accu,light,strobe, etc.</p>
<p>last no understand, what joystick library and were ? what need change ? and if need only max input what can, only button/switch, toggle sw, what need change and were ?</p>
<p>i not understand english good but i need my new arduino micro make maximum(how many?) toggle switch input only, how make ? (Motor and light+radio panel+audio control, whit fsuip. control ms9 simulator)</p><p>and how ? hid description, how arduino ino file ? how connect buttons ?</p><p>and second micro board need make only all (how many can?) encoders input.</p><p>if somebody can help me ?</p>
<p>I am constantly getting an error &quot;'Joystick' was not declared in this scope.&quot; ...............plz help</p>
<p>Not having the correct board selected (i.e. Arduino Micro or Arduino Leonardo) in the Arduino IDE is usually the cause of this error.</p>
I am using Arduino Uno, and I have selected this board only, so it won't work on Arduino Uno ?
This only works with the Arduino Leonardo and Arduino Micro.
<p>Good evening and sorry for the trouble.<br> But who wrote this guide, you may add links to do to connect:</p><p>X, Y, and Z axis (including rotation), 32 buttons, 2 hat switches, a throttle, and a rudder.</p>
<p>Jakkul has a good example of how he used the library on his blog at <a href="https://www.instructables.com/id/Ultimate-Classic-Game-Console-Joystick-to-USB-Adap/" style="">http://jakkul.blogspot.com/2015/06/sim-racing-and-game-controllers-part-2.html</a>. His example uses three potentiometers (connected to A0, A1, and A2). and two buttons. I have an example at <a href="https://www.instructables.com/id/Ultimate-Classic-Game-Console-Joystick-to-USB-Adap/">Ultimate Classic Game Console Joystick to USB Adapter</a> where I show how to use the library to connect classic game controllers to a modern PC. These should get you started.</p>
<p>Good evening and sorry for the trouble.<br> But who wrote this guide, you may add links to do to connect:</p><p>X, Y, and Z axis (including rotation), 32 buttons, 2 hat switches, a throttle, and a rudder.</p>
<p>Good evening and sorry for the trouble.<br> But who wrote this guide, you may add links to do to connect:</p><p>X, Y, and Z axis (including rotation), 32 buttons, 2 hat switches, a throttle, and a rudder.</p><p>Then it would be possible to bring the 4 hat switches</p>
is there any way to control a arduino with a quantum gamepad via usb host shield
<p>Theoretically yes, but I have not done anything like it. The USB Host Shield will allow the Arduino to act as the USB Host. The library that comes with the USB Host Shield should allow you to read the HID report. This might help: <a href="https://www.circuitsathome.com/communicating-arduino-with-hid-devices-part-1">https://www.circuitsathome.com/communicating-arduino-with-hid-devices-part-1</a></p>
thank you for the suggestion <br>
<p>aaaaand ... a few seconds later I had success! :)</p><p>You have to select the Arduino Leonardo/micro board for the sketch to compile! Good to know ;)</p>
<p>Just noticed that I wrote in the &quot;version &lt;= 1.6.6 instructible, but I correctly tested the updated library/files. </p><p>I tested both, after my first comment, but I had no success...</p>
<p>MattewH I am sorry but no matter what i try to do, after loading the sketch if i run a check of the &quot;JoystickButton&quot; example arduino returns 'Joystick' was not declared in this scope. </p><p>I am using the 1.6.6 version of the IDE and the libraries are listed in the contributed libraries ... any hint?<br></p>
<p>Hi</p><p>Is it possible for me to use the joystick library, and still use &quot;serial.print&quot; for a different function? </p><p>I tried using the joystick.begin and .end as well as the serial .begin and .end and putting the different code between them but i get no information in the serial monitor. The game controller buttons does still work.</p>
<p>This change should not affect the serial.print functions. They should work like they did before. I have used the Serial.print function on many occasions when I was debugging projects that use the Joystick library.</p><p>You might want to verify the baud rate on your serial monitor matches the Serial.begin function.</p>
<p>Hi MatthewH,</p><p>I'm sorry for my silence past 15 days.....</p><p>It might be a bit dumb, but I don't know much more after you wrote an reaction about JAKKUL on my first comment.</p><p>Meanwhile I was waiting 3 weeks for my pushbuttons to arrive from China.</p>
<p>I would start simple (i.e. just try to get a single button working) and then go from there. Create a simple sketch that reads the value of a physical button and calls the Joystick.setButton function. Once it is written, test it out and see if it works. If it does not, you can post the code to a comment and I (or someone else in this community) can take a look at what you have done and provide guidance. You can find a simple button press example on the following GitHub repository: <a href="https://github.com/MHeironimus/ArduinoJoystickLibrary/tree/master/Joystick/examples/JoystickButton">https://github.com/MHeironimus/ArduinoJoystickLibrary/tree/master/Joystick/examples/JoystickButton</a></p>
<p>keeps saying:</p><p>---------------------------------------------------------------------------------------------------------</p><p>Arduino: 1.6.7 (Windows 8.1), Board:&quot;Arduino/Genuino Micro&quot;<br><br>C:\Users\Eelco\Documents\Arduino\UsbJoystick\UsbJoystick.ino:18:22: fatal error: Joystick.h: No such file or directory<br><br> #include &lt;Joystick.h&gt;<br><br> ^<br><br>compilation terminated.<br><br>exit status 1<br>-------------------------------------------------------------------------------------------------------</p><p>while Joystick.h is in the directory....<br> </p>
<p>Verify you have the Joystick library installed. You should find this library in your C:\Users\&lt;your user name&gt;\Documents\Arduino\libraries folder. You will know you have the library installed properly if it appears in Arduino's Sketch -&gt; Include Library menu.</p>
<p>Hello MatthewH,</p><p>Thank you<br>very much for your tutorial. </p><p>We build a small customized Joystick within hours,<br>thanks to your description &hellip; but I still have a problem with one function. </p><p>It borders<br>me, that it isn&rsquo;t possible to see the z-Rotation in the Arduino Micro<br>Properties (Preview of Joystick signals) I<br>also cannot use it in a game (although<br>the games supports this axis) &hellip; but I can&rsquo;t find the error in the<br>HID-definition. The pointer definition seems legit.</p><p>Do you have<br>a clue how to fix that issue (so I can use also the z-Rotation)?</p><p>Thank you<br>in advance!</p>
<p>What operating system are you using (e.g. Windows 7, Windows 10, Linux, etc.)?</p><p> What game are you trying to play?</p><p> If your game has a controller configuration menu/screen, you could try to use that and see if the Z-Axis rotation can be configure. As far as I know, the Windows Game Controller Test dialog does not display/support the Z-Axis rotation. It should work in a game that supports a Z-Axis rotation, but I do not have a game like that I can test it with. </p>
<p>Hello MatthewH, </p><p>thanks for<br>the fast reply. I&rsquo;m using Win 10, but I also noticed the same issue on Win 7. The<br>only reason I come up with that is that I already saw another Demo implementation where the Z-Rotation was displayed in the Game Controller Test dialog (see <a href="https://www.pjrc.com/teensy/td_joystick.html" rel="nofollow">https://www.pjrc.com/teensy/td_joystick.html</a>).</p><p>But I cannot<br>see the difference between the two definitions. </p><p>However you saved me a lot of time with your detailed tutorial ^^. Thanks again! </p><p>If I find<br>some solution I&rsquo;ll inform you too.</p>
<p>One more thing...</p><p>There are various tutorials out there on the web for creating your own Report Descriptors. Here are a few I have come across:</p><p><a href="http://eleccelerator.com/tutorial-about-usb-hid-report-descriptors/">http://eleccelerator.com/tutorial-about-usb-hid-re...</a></p><p><a href="http://hamaluik.com/posts/making-a-custom-teensy3-hid-joystick/">http://hamaluik.com/posts/making-a-custom-teensy3-...</a></p><p><a href="http://www.usb.org/developers/hidpage/">http://www.usb.org/developers/hidpage/</a></p>
<p>I see from your link that someone got a Z-Axis Rotation working. Unfortunately I am very busy right now, otherwise I would try to solve that issue for you, but I will give you an idea of something can try:</p><p>I noticed on the Test Dialog shown on the link you provided, their joystick had fewer features than the one provided in this Instructable. I would try simplifying the Joystick Definition to only include the items you absolutely need. This will probably be easier to do using the instructions provided in the <a href="https://www.instructables.com/id/Arduino-LeonardoMicro-as-Game-ControllerJoystick/">Arduino Leonardo/Micro as Game Controller/Joystick</a> Instructable, but it can be done by modifying the HID.cpp and USBAPI.h file provided in this Instructable. The main thing you will need to change is the _hidReportDescriptor, defined in the HID.cpp file (or the Joystick.cpp if you are using Arduino 1.6.6). You will also need to update the data array in the Joystick_::sendState function to match the new structure you define in the _hidReportDescriptor.</p><p>Good luck.</p>
<p>Dear MatthewH,</p><p>Everything was going good untill I came at step 9. Because I am new to arduino's and programming,I was trying to understand how step 9 works, But I couldn't.</p><p>My goal is to get as much pushbuttons connected including the X, Y and Z axis (for gas, brake and a streer).</p><p>I am using An Arduino Micro.</p><p>I would really appreciate if you could help me, or someone else.</p>
<p><a href="https://www.blogger.com/profile/18199889318757170723" style="">JAKKUL</a> has a good article on his blog that shows how to use this library to create a custom game controller: <a href="http://jakkul.blogspot.com/2015/06/sim-racing-and-game-controllers-part-2.html">http://jakkul.blogspot.com/2015/06/sim-racing-and-...</a></p><p>Take a look at that and let me know if that helps.</p>
<p>Hello!</p><p>I'm using IDE 1.6.5 with Sparkfun's pro micro 3.3V.<br>I'm stuck here: </p><p>______________________________________________________________</p><p>In file included from UsbJoystickTest.ino:1:0:</p><p>C:\Users\********\Documents\Arduino\libraries\Joystick/Joystick.h:24:17: fatal error: HID.h: No such file or directory</p><p> #include &quot;HID.h&quot;</p><p> ^</p><p>compilation terminated.<br>______________________________________________________________</p><p>What's wrong?</p>
<p>Verify you have the correct board selected (e.g. Arduino/Genuino Micro) in the Arduino IDE's Tools -&gt; Board menu.</p><p>If that does not fix the issue, I would recommend upgrading to the Arduino 1.6.6 IDE and follow the steps on the &quot;Arduino Leonardo/Micro as Game Controller/Joystick&quot; instructable (https://www.instructables.com/id/Arduino-LeonardoMicro-as-Game-ControllerJoystick/). The 1.6.6 IDE actually makes this a lot easier to do.</p>
<p>Very useful ! Thank you for this tutorial. Do you know how I can do the Step 6 on Windows 10 ? Right clic is not working :(</p>
<p>That's strange. Step 6 is the same on a Windows 10 machine. Do you get a context menu at all when you right-click on the Arduino in the &quot;Devices and Printers&quot; window or is it just that the &quot;Game controller settings&quot; option is missing?</p>
My fault ! I was not in Devices and Printers window. It's working fine ! Thanks again for this tutorial.
<p>yeah, I've made it. Pics and videos are here:</p><p><a href="http://jakkul.blogspot.com/2015/06/my-first-arduino-racing-pad-video-and.html" rel="nofollow">http://jakkul.blogspot.com/2015/06/my-first-arduin...</a></p><p><a href="http://jakkul.blogspot.com/2015/06/sim-racing-and-game-controllers-part-2.html" rel="nofollow">http://jakkul.blogspot.com/2015/06/sim-racing-and-...</a></p>
<p>I am glad to see it worked for you. I noticed your comment &quot;I think, that 8bits of data fed by Arduino to the PC for steering are not enough.&quot; I am pretty sure that could be increased to 16 or 32 if you need it to be. To do this you will need to modify the definition of the X, Y, and Z axis in the _hidReportDescriptor array in the HID.cpp file (specifically the LOGICAL_MINIMUM (-127), LOGICAL_MAXIMUM (127), and REPORT_SIZE (8) elements). You can take a look at <a href="http://www.microchip.com/forums/m238459.aspx" rel="nofollow">http://www.microchip.com/forums/m238459.aspx </a> for some example HID report descriptors that use something other than 8-bits. (I only needed 8-bits for what I was using it for.) You will also need to update the setXAxis, setYAxis, and setZAxis functions in the USBAPI.h and HID.cpp files to accept a bigger number.</p><p>Let me know if you need some help with this.</p>
<p>Hey, thanks! I'll try that for sure. </p><p>Should I care about the total length of the HID descriptor? I know this is probably a very basic question, but my experiments with arduino were my first exposure to HID USB communication :)</p><p>I've also found this: </p><p><a href="http://forum.freetronics.com/viewtopic.php?t=734#p2245" rel="nofollow">http://forum.freetronics.com/viewtopic.php?t=734#p...</a> The author of this post provides examples for a 3 axis 6 button joystick, where one of the axis' (steering) is 10 bit. </p>
<p>Yes, you will need to increase the joystickStateSize to match your new report length. The files included in the link you posted look like they would work for your purposes (you will just need to update your sketch file to use the different Joystick library's funtions).</p><p>If for some reason those other files do not work for you, I can try to update the files I posted to have a bigger value for X, Y, and Z if you need me to.</p>
<p>Sir my accelarator and brakes for car simulation is working but sterring is not responsing kindly provide me help for this ...I am totally new on HID</p>

About This Instructable

79,997views

90favorites

License:

More by MatthewH:Create a Joystick Using the Arduino Joystick Library 2.0 Remote Control Your Raspberry Pi Ultimate Classic Game Console Joystick to USB Adapter 
Add instructable to: