Skip to content
XInput library for USB capable Arduino boards
Branch: master
Clone or download
dmadison Move API demo connection check after callback
Alows callback to be called during configuration, and avoids waiting on the USB buffer
Latest commit 7503b14 Apr 7, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Add begin function Mar 8, 2019
extras Move API demo connection check after callback Apr 8, 2019
src Change joystick SOCD to match D-Pad Apr 3, 2019
.gitignore gitignore Nov 3, 2018
.travis.yml Travis CI (#13) Mar 22, 2019
LICENSE MIT License Mar 7, 2019
README.md Add ArduBadge to README Mar 29, 2019
keywords.txt Refactor class as XInputController Mar 10, 2019
library.properties Version 1.1.0 Apr 3, 2019

README.md

Arduino XInput Library

arduino-library-badge Build Status

This library lets you easily emulate an Xbox 360 controller using a USB-capable Arduino microcontroller.

Getting Started

void setup() {
	XInput.begin();
}

void loop() {
	XInput.press(BUTTON_A);
	delay(1000);
	
	XInput.release(BUTTON_A);
	delay(1000);
}

Before the library will work, you must install a compatible boards file that contains the XInput USB descriptors, otherwise the microcontroller won't behave like an XInput device. This is not optional. See the compatible boards section below for more information.

After installing a compatible boards package, you must then download and install the library. Once the XInput library is installed, open up the Arduino IDE and load an example sketch, located in File -> Examples -> XInput (I suggest trying the 'Blink' sketch first). Double-check that you have the correct XInput board selected in the 'Tools' menu, then upload the sketch to your microcontroller.

On Windows, you can test that the sketch is working properly by opening up the joystick control panel (joy.cpl) or by using GamepadViewer.com. If you uploaded the XInput 'Blink' example, the #1 button ('A') should be slowly turning on and off.

Control Surfaces

The library gives you access to the following controls available on the Xbox 360 controller:

  • 10 + 1 Digital Buttons
  • 2 Analog Joysticks (16 bit)
  • 2 Analog Triggers (8 bit)
  • 1 Four-Way Directional Pad (D-Pad)

The library also processes received data, so you can read the status of the controller's 2 rumble motors (8-bit), the assigned player number (1-4), and the index of the current LED animation. Data is sent and received automatically over USB.

Compatible Boards

To function as an XInput device, you must use a compatible boards package with XInput USB descriptors. This is not optional. Without these descriptors the library will only function in "debug" mode and the microcontroller will not behave as an XInput device.

The following boards packages are available:

  • Arduino AVR Core Boards

    Modifies the Arduino AVR core to emulate an XInput device. Includes support for the Arduino Leonardo, Micro, Yun, and more.

  • SparkFun AVR Boards

    Provides support for the MaKey MaKey, Pro Micro, Fio, Qduino Mini, and LilyPad USB Plus. Requires the XInput AVR Core boards.

  • Teensy 3 Boards

    Includes an 'XInput' USB mode for the Teensy 3.1, 3.2, 3.5, 3.6, and LC microcontrollers. Requires a preexisting Teensyduino installation.

For a complete list of available packages and compatible boards see the 'supported boards' file. For information on how to add support for another Arduino-compatible board with native USB support, see the documentation on the USB API.

License

This library is licensed under the terms of the MIT license. See the LICENSE file for more information.

You can’t perform that action at this time.