This project contains custom firmware compatible with a number of different CH55x based programmable keypads found on sites like AliExpress and Amazon.
Don't have a keypad yet? See the supported devices section for some compatible options.
If you're using a new device for the first time, please refer to the bootloader documentation for instructions on how to enter bootloader mode on your device.
Visit https://keypad-flasher.amyjeanes.com in a WebUSB compatible browser (anything based on Chromium, e.g. Chrome, Edge, Opera) once you have the device in bootloader mode and follow the instructions in the web app to configure and flash the new firmware to your keypad.
Please note that the original firmware on the device will be lost when you flash this custom firmware, so only proceed if you are okay with that.
If you wish to help develop the project, please see the development documentation.
The following is a list of supported devices. Other CH55x based keypads may also be compatible but will need to be added to this project first. See the developer instructions for how to add support for new devices.
They all have USB-C connectors unless otherwise noted:
- 2 Keys
- Uses non-standard LEDs that are not compatible with this project's NeoPixel support so LED functionality will not work
- 3 Keys 1 Knob
- 4 Keys
- 6 Keys 1 Knob
- 6 Keys 1 Knob (Sikai)
- 10 Keys
- Uses fixed blue LEDs that are always on and cannot be controlled by the firmware
These devices have been tested and found to use different types of microcontrollers, and are not compatible with this firmware:
- 9 Keys
- Uses a CH32V203 microcontroller
- Can remap keys using https://sayodevice.com/ web-based flasher (similar to this project!)
- 12 Keys 2 Knobs
- Uses a CH579M microcontroller
- Can remap keys using https://github.com/kriomant/ch57x-keyboard-tool or other CH57x programming tools