Skip to content

Commit 156bce7

Browse files
authored
Update README.md
1 parent 203da61 commit 156bce7

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,3 @@
1-
## POSSIBLE BREAKING CHANGES - PLEASE READ
2-
A large code rebase (configuration class) along with some extra features (start, select, menu, home, back, volume up, volume down and volume mute buttons) has been committed thanks to @dexterdy
3-
4-
Since version 5 of this library, the axes and simulation controls have configurable min and max values
5-
The decision was made to set defaults to 0 for minimum and 32767 for maximum (previously -32767 to 32767)
6-
This was due to the fact that non-Windows operating systems and some online web-based game controller testers didn't play well with negative numbers. Existing sketches should take note, and see the DrivingControllerTest example for how to set back to -32767 if wanted
7-
8-
This version endeavors to be compatible with the latest released version of NimBLE-Arduino through the Arduino Library Manager; currently version 2.1.3 at the time of this writing; --> https://github.com/h2zero/NimBLE-Arduino/releases/tag/2.1.3
9-
10-
Please see updated examples
11-
12-
## NimBLE
13-
Since version 3 of this library, the more efficient NimBLE library is used instead of the default BLE implementation
14-
Please use the library manager to install it, or get it from here: https://github.com/h2zero/NimBLE-Arduino
15-
Since version 3, this library also supports a configurable HID desciptor, which allows users to customise how the device presents itself to the OS (number of buttons, hats, axes, sliders, simulation controls etc).
16-
See the examples for guidance.
17-
181
# ESP32-BLE-Gamepad
192

203
## License
@@ -42,7 +25,24 @@ It would be great however if any improvements are fed back into this version.
4225
- [x] Compatible with Linux (limited testing)
4326
- [x] Compatible with MacOS X (limited testing)
4427
- [ ] Compatible with iOS (No - not even for accessibility switch - This is not a “Made for iPhone” (MFI) compatible device)
45-
(Use the Xinput fork suggested below which has been tested to work)
28+
(Use the Xinput fork suggested below which has been tested to work)
29+
30+
## NimBLE
31+
Since version 3 of this library, the more efficient NimBLE library is used instead of the default BLE implementation
32+
Please use the library manager to install it, or get it from here: https://github.com/h2zero/NimBLE-Arduino
33+
Since version 3, this library also supports a configurable HID desciptor, which allows users to customise how the device presents itself to the OS (number of buttons, hats, axes, sliders, simulation controls etc).
34+
See the examples for guidance.
35+
36+
## POSSIBLE BREAKING CHANGES - PLEASE READ
37+
A large code rebase (configuration class) along with some extra features (start, select, menu, home, back, volume up, volume down and volume mute buttons) has been committed thanks to @dexterdy
38+
39+
Since version 5 of this library, the axes and simulation controls have configurable min and max values
40+
The decision was made to set defaults to 0 for minimum and 32767 for maximum (previously -32767 to 32767)
41+
This was due to the fact that non-Windows operating systems and some online web-based game controller testers didn't play well with negative numbers. Existing sketches should take note, and see the DrivingControllerTest example for how to set back to -32767 if wanted
42+
43+
This version endeavors to be compatible with the latest released version of NimBLE-Arduino through the Arduino Library Manager; currently version 2.1.3 at the time of this writing; --> https://github.com/h2zero/NimBLE-Arduino/releases/tag/2.1.3
44+
45+
Please see updated examples
4646

4747
## Installation
4848
- (Make sure you can use the ESP32 with the Arduino IDE. [Instructions can be found here.](https://github.com/espressif/arduino-esp32#installation-instructions))

0 commit comments

Comments
 (0)