lym555/bluepad32

Bluetooth gamepad support for the ESP32 (mirror)

Bluepad32

A Bluetooth gamepad "host" for the ESP32.

Add Bluetooth gamepad support to your projects easily. Supported platforms:

• Arduino + ESP32 boards:
  • Documentation
  • Template project (🠐 START HERE)
  • From the community: Lego Robot (video), gbaHD Shield (a GameBoy consolizer)
• Arduino + boards with the NINA coprocessor:
  • Documentation
  • Library
  • From the community: Philips CD-i meets Bluetooth
• CircuitPython + boards with the AirLift coprocessor:
  • Documentation
  • Library
  • From the community: Quico console, Controlling 4 servos (video)
• Or in custom boards like:
  • Unijoysticle v2, to play games on the Commodore 64
  • or on the Commodore Amiga
  • ULX3S, an FPGA console

Note: Only the original ESP32 is supported, which supports Bluetooth Classic. Newer models like ESP32-Sx, ESP32-Cx, ESP32-Hx are NOT supported since they don't support Bluetooth Classic.

Features

• Supports most, if not all, modern Bluetooth gamepads and mice (see below)
• Fast (very low latency)
• Small footprint
• Uses only one core (CPU0). The remaining one is free to use.
• C11 based
• Open Source (see below)

Supported controllers

• Sony DualSense (PS5)
• Sony DUALSHOCK 4 (PS4)
• Sony DUALSHOCK 3 (PS3)
• Nintendo Switch Pro controller
• Nintendo Switch JoyCon
• Nintendo Wii U controller
• Nintendo Wii Remote + accesories
• Xbox Wireless controller (model 1708)
• Android gamepads
• PC/Window gamepads
• 8BitDo controllers
• iCade
• Mouse
• And more

See: Supported gamepads and supported mice

How to compile it

1. Install ESP-IDF

   Install the ESP32 toolchain. Use version 4.4.1. Might work on newer / older ones, but not tested.

   • https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/

2. Clone repo

   git clone --recursive https://gitlab.com/ricardoquesada/bluepad32.git

3. Integrate BTStack into ESP32

   cd ${BLUEPAD32}/external/btstack/port/esp32
   # This will install BTstack as a component inside Bluepad32 source code (recommended).
   # Remove "IDF_PATH=../../../../src" if you want it installed in the ESP-IDF folder
   IDF_PATH=../../../../src ./integrate_btstack.py

4. Compile Bluepad32

   Choose target platform (default is Unijoysticle):

   cd ${BLUEPAD32}/src
   idf.py menuconfig

   The Bluepad32 options are in: Components config -> Bluepad32 (find it at the very bottom) -> Target platform

   And compile it:

   idf.py build

5. Flash it

   idf.py flash monitor

Support

• Documentation
• Discord
• Google groups

License

Bluepad32 is open source, licensed under Apache 2.

However Bluepad32 depends on the great BTStack library. Which is free to use for open source projects. But commercial for closed-source projects. Contact them for details. They are very friendly + helpful (I’m not affiliated with them).