Merge pull request MHeironimus#80 from MHeironimus/master

Update version-2.0 branch with latest changes from master

Author: MHeironimus

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+## How to contribute to the Arduino Joystick Library
+
+### Report a bug
+
+* **Check to see if the bug has already reported** by searching on GitHub under [Issues](https://github.com/MHeironimus/ArduinoJoystickLibrary/issues).
+
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/MHeironimus/ArduinoJoystickLibrary/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible (e.g. host OS, Arduino IDE version, etc.), any important hardware information (e.g. name of Arduino board being used, specific pin wirings if they are relavant, etc.), and a **sample sketch** file demonstrating the issue.
+
+### Fix a bug
+
+* Open a new GitHub pull request with the fix.
+
+* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+
+### Whitespace, format code, or cosmetic updates
+
+* Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability will generally not be accepted.
+
+### Adding a new feature
+
+* Feel free to [create a new issue](https://github.com/MHeironimus/ArduinoJoystickLibrary/issues/new) to document the feature you are planning to add. This will allow others to see and comment on what you would plan to add to the library.
+
+### Questions about the library
+
+* Be sure to check the [FAQ](https://github.com/MHeironimus/ArduinoJoystickLibrary/wiki/FAQ) in the [Wiki](https://github.com/MHeironimus/ArduinoJoystickLibrary/wiki) to see if your question has already been answered.
+* Another good place to look for general Arduino questions is the [Arduino]() website.
+
+The Arduino Joystick Library is a volunteer effort done in volunteer's spare time. Please be patient as it may take some time for bugs to be fixed, features to be added, and questions to be answered.

Joystick/library.properties

@@ -1,9 +1,9 @@
 name=Joystick
-version=2.0.4
+version=2.0.5
 author=Matthew Heironimus
 maintainer=Matthew Heironimus <[email protected]>
-sentence=Arduino library that allows an Arduino Leonardo or Arduino Micro to appear as a Joystick or Gamepad. 
+sentence=Arduino library that allows an Arduino Leonardo, Arduino Micro, or Arudino Due to appear as a Joystick or Gamepad.
 paragraph=This library is built on the PluggableUSB library. It can be used with or without other HID-based libraries (Mouse, Keyboard, etc.).
 category=Device Control
 url=https://github.com/MHeironimus/ArduinoJoystickLibrary
-architectures=avr
+architectures=avr,sam

Joystick/src/DynamicHID/DynamicHID.cpp

@@ -23,6 +23,11 @@
 
 #if defined(USBCON)
 
+#ifdef _VARIANT_ARDUINO_DUE_X_
+#define USB_SendControl USBD_SendControl
+#define USB_Send USBD_Send
+#endif
+
 DynamicHID_& DynamicHID()
 {
 	static DynamicHID_ obj;
@@ -91,11 +96,10 @@ void DynamicHID_::AppendDescriptor(DynamicHIDSubDescriptor *node)
 
 int DynamicHID_::SendReport(uint8_t id, const void* data, int len)
 {
-	auto ret = USB_Send(pluggedEndpoint, &id, 1);
-	if (ret < 0) return ret;
-	auto ret2 = USB_Send(pluggedEndpoint | TRANSFER_RELEASE, data, len);
-	if (ret2 < 0) return ret2;
-	return ret + ret2;
+	uint8_t p[len + 1];
+	p[0] = id;
+	memcpy(&p[1], data, len);
+	return USB_Send(pluggedEndpoint | TRANSFER_RELEASE, p, len + 1);
 }
 
 bool DynamicHID_::setup(USBSetup& setup)

Joystick/src/DynamicHID/DynamicHID.h

@@ -24,7 +24,18 @@
 
 #include <stdint.h>
 #include <Arduino.h>
-#include "PluggableUSB.h"
+
+#ifdef _VARIANT_ARDUINO_DUE_X_
+  // The following values are the same as AVR's USBAPI.h
+  // Reproduced here because SAM doesn't have these in
+  // its own USBAPI.H
+  #define USB_EP_SIZE 64
+  #define TRANSFER_PGM 0x80
+
+  #include "USB/PluggableUSB.h"
+#else
+  #include "PluggableUSB.h"
+#endif
 
 #if defined(USBCON)
 
@@ -108,7 +119,11 @@ class DynamicHID_ : public PluggableUSBModule
   uint8_t getShortName(char* name);
 
 private:
+  #ifdef _VARIANT_ARDUINO_DUE_X_
+  uint32_t epType[1];
+  #else
   uint8_t epType[1];
+  #endif
 
   DynamicHIDSubDescriptor* rootNode;
   uint16_t descriptorSize;

README.md

@@ -1,6 +1,6 @@
 # Arduino Joystick Library
-#### Version 2.0.4
-This library can be used with Arduino IDE 1.6.6 (or above) to add one or more joysticks (or gamepads) to the list of HID devices an [Arduino Leonardo](https://www.arduino.cc/en/Main/ArduinoBoardLeonardo) or [Arduino Micro](https://www.arduino.cc/en/Main/ArduinoBoardMicro) (or any Arduino clone that is based on the ATmega32u4) can support. This will not work with Arduino IDE 1.6.5 (or below) or with non-32u4 based Arduino devices (e.g. Arduino UNO, Arduino MEGA, etc.).
+#### Version 2.0.5
+This library can be used with Arduino IDE 1.6.6 (or above) to add one or more joysticks (or gamepads) to the list of HID devices an [Arduino Leonardo](https://www.arduino.cc/en/Main/ArduinoBoardLeonardo) or [Arduino Micro](https://www.arduino.cc/en/Main/ArduinoBoardMicro) (or any Arduino clone that is based on the ATmega32u4) can support. This library will also work with the [Arduino Due](https://www.arduino.cc/en/Main/ArduinoBoardDue), thanks to [@Palakis](https://github.com/Palakis). A complete list of supported boards can be found in the [Wiki](https://github.com/MHeironimus/ArduinoJoystickLibrary/wiki/Supported-Boards). This will not work with Arduino IDE 1.6.5 (or below) or with non-32u4 based Arduino devices (e.g. Arduino UNO, Arduino MEGA, etc.).
 
 ## Features
 The joystick or gamepad can have the following features:
@@ -185,45 +185,4 @@ Sets the value of the specified hat switch. The hatSwitch is 0-based (i.e. hat s
 ### 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).
 
-## Testing Details
-I have used this library to make an Arduino appear as the following:
-
-- 1 joystick / gamepad
-- 2 joysticks / gamepads
-- 3 joysticks / gamepads
-- 4 joysticks / gamepads
-
-I have tested with 1 - 32 buttons using the standard Microsoft Windows Game Controller Test dialog. 
-I have also tested this with 1 - 64 buttons. 
-To test a joystick with over 32 buttons, a third-party testing tool will need to be used (e.g. http://www.planetpointy.co.uk/joystick-test-application/).
-
-I have tested with 0, 1, and 2 hat switches.
-
-I have tested this library using the following Arduino IDE Versions:
-
-- 1.6.6 through 1.6.13
-- 1.8.0 through 1.8.4
-
-I have tested this library with the following boards:
-
-- [Arduino Leonardo](https://www.arduino.cc/en/Main/ArduinoBoardLeonardo)
-- [Arduino Micro](https://www.arduino.cc/en/Main/ArduinoBoardMicro)
-
-Others have tested this library with the following boards:
-
-- [SparkFun Pro Micro](https://www.sparkfun.com/products/12640)
-- [RobotDyn Micro ATmega32U4-MU](http://robotdyn.com/catalog/boards/micro_atmega32u4_mu/) by [@Sylverzerom](https://github.com/Sylverzerom)
-
-Boards that should work, but I have not personally tested:
-
-- [Arduino Leonardo ETH](https://store.arduino.cc/usa/arduino-leonardo-eth)
-- [Arduino Industrial 101](https://store.arduino.cc/usa/arduino-industrial-101)
-- [Arduino Yún](https://store.arduino.cc/usa/arduino-yun)
-
-Other board notes:
-- [Arduino Due](https://www.arduino.cc/en/Main/ArduinoBoardDue) - NOT Supported - I have been told that the old Arduino IDE 1.6.5 (and below) version of this library (see [Add USB Game Controller to Arduino Leonardo or Micro](http://mheironimus.blogspot.com/2015/03/add-usb-game-controller-to-arduino.html))
-works with the Arduino Due. I have also been told Version 1.x of the the Arduino Joystick Library will work with the Arduino Duo. However, Version 2.x of the Arduino Joystick Library does not work with Arduino Due at this time.
-- [Arduino UNO](https://www.arduino.cc/en/Main/ArduinoBoardUno) - NOT Supported - However, it might work with the [NicoHood/HoodLoader2](https://github.com/NicoHood/HoodLoader2) library, but I have not had a chance to try this out yet.
-- [Arduino MEGA](https://www.arduino.cc/en/Main/ArduinoBoardMega2560) - NOT Supported - However, it might work with the [NicoHood/HoodLoader2](https://github.com/NicoHood/HoodLoader2) library, but I have not had a chance to try this out yet.
-
-(as of 2017-09-02)
+See the [Wiki](https://github.com/MHeironimus/ArduinoJoystickLibrary/wiki) for more details on things like FAQ, supported boards, testing, etc.