The goal of this project was to create wireless support for the YamPAD macropad using ZMK. The creator of the YamPAD originally intended wired compatability with QMK flashing.
If you are not familiar with ZMK I highly suggest that you take a look at the documentation to familiarize yourself with the installation process. The YamPAD is not included in ZMK's list of supported shields, so we have to build our own firmware. I suggest following this guide to accomplish this.
This repo contains all the necessary files to build the .uf2 file to flash on the MCU. Once flashed, the macropad should be ready to use. You can use GitHub Actions to build your own firmware, but if you run into issues with that, you could also create a local build on your machine.
- Alternatives: ProMicro NRF52840
I went with the ProMicro NRF52840
- Bluetooth
- OLED Display
- Keymap Layers (Modifiable)
RGB support is soon to be added
- ZMK comes with it's own OLED configuration. Currently, there is not sufficient documentation to create custom displays. See
- For wireless macropads, an OLED display is not recommended because it will greatly drain the battery. However, you could go with the nice!view display which has a much lower power draw.
- Check for any hardware issues: diodes, switches, connections, etc.
The YamPAD is an open source macropad by Mattia Dal Ben
ZMK Firmware is an open source (MIT) keyboard firmware built on the Zephyr™ Project Real Time Operating System (RTOS). ZMK's goal is to provide a modern, wireless, and powerful firmware free of licensing issues.