about summary refs log tree commit diff

path: root/README.md

blob: 329fc9ecea973939b6784278e36ae57296140b9b (plain)

XInput USB Core for Arduino AVR

The files in this repository allow you to emulate an Xbox gamepad (XInput) using a USB-capable Arduino microcontroller.

This is meant to be used in conjunction with the ArduinoXInput library.

Installation

└───Arduino Installation
    ├───drivers
    ├───examples
    ├───hardware
    │   ├───arduino
    │   ├───tools
    │   └───xinput
    │       └───avr
    │           ├───bootloaders
    │           ├───cores
    │           ├───libraries
    │           └───variants
    ├───java
    ├───lib
    ├───libraries
    ├───reference
    ├───tools
    └───tools-builder

To install, download the latest version of this repository to your PC. Navigate to the directory containing your Arduino installation, and then open up the 'hardware' folder. Extract the contents of the .zip file into this directory. You should have a new 'xinput' folder with an 'avr' folder inside of it, containing the files from this repository (see the tree view above).

Restart the Arduino IDE. If the XInput AVR core is installed correctly, you should see a new collection of "XInput AVR Boards" in the Tools -> Boards menu.

To uninstall, delete the 'xinput' folder in the 'hardware' directory, and then restart the Arduino IDE.

Upload Warning and Instructions

!!!!!!! IMPORTANT !!!!!!!

Due to the nature of how the XInput USB mode works, Arduinos that have XInput sketches on them will not automatically reset when programmed by the IDE! You will need to reset the board by hand every time you upload new code.

You can ignore this section if you're using an external programmer.

How to Upload

Connect the board to your computer using a USB cable, and make sure you have the proper board selected in the IDE's 'boards' menu (with or without XInput). If the board already has an XInput sketch on it, you do not need to select a serial port. You should also turn on 'verbose output' for uploading in the Arduino IDE's preferences (File -> Preferences). This makes it easier to time the manual reset and see if the upload succeeded.

Lastly, you need to know where the 'reset' button is on your Arduino. If your board does not have a 'reset' button, you can wire your own by momentarily connecting the 'reset' pin to ground.

To upload to the board: * Press the 'Upload' button in the IDE * Wait until the status bar says "Uploading..." * Press the reset button twice, quickly

If you did these steps properly, the board should reset to the bootloader and the upload should begin. AVRDUDE will do its thing and you should see avrdude done. Thank you. near the bottom of the output window.

Note that the IDE may say that it "Couldn't find a Board on the selected port" even if the upload succeeded. This is why it's important to turn on the verbose uploading output - look for the avrdude message.

Do not upload XInput sketches to your Arduino unless you know how to reset it! Otherwise you will not be able to program it anymore and you'll have to reflash the bootloader with an external programmer.

Supported Boards

Unfortunately boards such as the Uno, Nano, or Mega that do not have native USB support will not work.

Limitations

No Console Support

This will not enable you to use your Arduino with an Xbox console! Genuine controllers use a dedicated hardware security chip that handshakes with the console. The Arduinos do not have this chip, and its security method has not been (openly) broken.

No Commercial Use

These board definitions make use of Microsoft's VID and PID in order to latch on to the PC driver. As such this is strictly for educational or development use by non-commercial entities.

License

The Arduino core files are licensed under the terms of the GNU Lesser General Public License (LGPL) version 2.1. Modifications are released under these same terms. See the LICENSE file for more information.

Newly contributed files for XInput support are licensed under the terms of the more permissive MIT license.