Note
Reading this documentation carefully from start to finish will save you a lot of time and effort.
-
How to customize in order to build your own hardware and firmware setup
-
Ready to deploy designs:
These designs work as an example of several implementation choices. Setup9 is the recommended way to go.
Name Usage DevKit Inputs summary Main power source Setup1 Steering wheel ESP32-WROOM-32E/UE Rotary encoders x4, DPAD or funky switch (optional), analog clutch paddles, 12 push buttons External Setup2 Button box ESP32-WROOM-32E/UE Rotary encoders x4, 52 push buttons External Setup3 Steering wheel TinyPico Rotary encoders x2, DPAD (optional), analog clutch paddles, 10 push buttons Battery Setup4 Steering wheel TinyPico Rotary encoders x3, analog clutch paddles, 10 push buttons Battery or external Setup5 Steering wheel LilyGO T-QT PRO Rotary encoders x3, digital clutch paddles, 9 push buttons Battery or external Setup6 Steering wheel Lolin32 Lite Rotary encoders x4, analog clutch paddles, 16 push buttons External Teabox Button box Lolin32 Lite Rotary encoder, two-way push lever, 3 push buttons External Setup7 Steering wheel LilyGO T-QT PRO Rotary encoders x3, analog clutch paddles, 20 push buttons Battery or external Setup8 Button box LilyGO T-QT PRO Rotary encoders x4, 21 push buttons USB Setup9 Steering wheel Wemos S3 mini Rotary encoders x7, funky switch or DPAD, analog clutch paddles, 32 push buttons External -
Changing your device's display name (Windows only) or Hardware ID
-
Telemetry:
-
Printed circuit board (PCB) designs:
- Overview of PCBs
- Auxiliary module for 24 switches (through hole mounting)
- Auxiliary module for 32 switches (through hole mounting)
- Auxiliary module for 25 switches (button matrix)
- Auxiliary module for play and charge (32 switches, battery charger and fuel gauge)
- All-in-one custom DevKit (ESP32-S3) for simracing
-
ESP32C3 boards exposes a slightly different power management API than other ESP32 boards. The firmware has been updated, but not tested. Deep sleep mode may not work properly in battery-operated setups on these boards.
-
Device not working after a firmware upgrade. This issue is caused by an operating system cache. Fix:
- BLE devices: remove from the Bluetooth control panel then pair again.
- USB devices: remove from the device manager then reboot your computer. Ensure the operating system is detecting your device as new hardware.
-
Device not discoverable in Windows 11 version 25H2 (BLE only). It seems this issue is caused by a bug in this version. There are two viable workarounds:
- Go to Settings > System > Recovery > Fix problems using Windows Update > Reinstall now.
- Uninstall the update. Unfortunately, Windows 11 will reinstall again the 25H2 version later. There are ways to pin Windows to an older version. Search online.
Reset your device before pairing again.
You may still contribute even if you don't have software development skills or in-depth knowledge of this project.
See how to contribute.
- Glossary of terms and definitions
- Firmware architecture
- Overview of Quality Controls
- Notes on HID device implementation. If you plan to develop an application that interfaces this firmware, you should read this.
- API documentation (automatically generated by Doxygen)
- Configuration management policy
- Change log