Skip to content

Commit e679781

Browse files
committed
Moved the more volatile sections of the README into the Wiki
1 parent 8e1ad7e commit e679781

File tree

2 files changed

+3
-43
lines changed

2 files changed

+3
-43
lines changed

Joystick/library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name=Joystick
22
version=2.0.5
33
author=Matthew Heironimus
44
maintainer=Matthew Heironimus <[email protected]>
5-
sentence=Arduino library that allows an Arduino Leonardo or Arduino Micro to appear as a Joystick or Gamepad.
5+
sentence=Arduino library that allows an Arduino Leonardo, Arduino Micro, or Arudino Due to appear as a Joystick or Gamepad.
66
paragraph=This library is built on the PluggableUSB library. It can be used with or without other HID-based libraries (Mouse, Keyboard, etc.).
77
category=Device Control
88
url=https://github.com/MHeironimus/ArduinoJoystickLibrary

README.md

Lines changed: 2 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Arduino Joystick Library
22
#### Version 2.0.5
3-
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.).
3+
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/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.).
44

55
## Features
66
The joystick or gamepad can have the following features:
@@ -185,44 +185,4 @@ Sets the value of the specified hat switch. The hatSwitch is 0-based (i.e. hat s
185185
### Joystick.sendState()
186186
Sends the updated joystick state to the host computer. Only needs to be called if `AutoSendState` is `false` (see `Joystick.begin` for more details).
187187

188-
## Testing Details
189-
I have used this library to make an Arduino appear as the following:
190-
191-
- 1 joystick / gamepad
192-
- 2 joysticks / gamepads
193-
- 3 joysticks / gamepads
194-
- 4 joysticks / gamepads
195-
196-
I have tested with 1 - 32 buttons using the standard Microsoft Windows Game Controller Test dialog.
197-
I have also tested this with 1 - 64 buttons.
198-
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/).
199-
200-
I have tested with 0, 1, and 2 hat switches.
201-
202-
I have tested this library using the following Arduino IDE Versions:
203-
204-
- 1.6.6 through 1.6.13
205-
- 1.8.0 through 1.8.4
206-
207-
I have tested this library with the following boards:
208-
209-
- [Arduino Leonardo](https://www.arduino.cc/en/Main/ArduinoBoardLeonardo)
210-
- [Arduino Micro](https://www.arduino.cc/en/Main/ArduinoBoardMicro)
211-
212-
Others have tested this library with the following boards:
213-
214-
- [SparkFun Pro Micro](https://www.sparkfun.com/products/12640)
215-
- [RobotDyn Micro ATmega32U4-MU](http://robotdyn.com/catalog/boards/micro_atmega32u4_mu/) by [@Sylverzerom](https://github.com/Sylverzerom)
216-
- [Arduino Due](https://www.arduino.cc/en/Main/ArduinoBoardDue) by [@Palakis](https://github.com/Palakis)
217-
218-
Boards that should work, but I have not personally tested:
219-
220-
- [Arduino Leonardo ETH](https://store.arduino.cc/usa/arduino-leonardo-eth)
221-
- [Arduino Industrial 101](https://store.arduino.cc/usa/arduino-industrial-101)
222-
- [Arduino Yún](https://store.arduino.cc/usa/arduino-yun)
223-
224-
Other board notes:
225-
- [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.
226-
- [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.
227-
228-
(as of 2017-09-02)
188+
See the [Wiki](https://github.com/MHeironimus/ArduinoJoystickLibrary/wiki) for more details on things like FAQ, supported boards, testing, etc.

0 commit comments

Comments
 (0)