NOTE: This firmware is a work in progress and is not stable. Use at your own risk.
This is an unofficial port of the ZMK firmware to the MNT Reform Keyboard V4.0 based on the RP2040 MCU.
Initially, I aim to get all of the hardware working under ZMK and support the standalone keyboard usecase.
In the future, I hope to implement full support for the laptop usecase as well.
The USB HID is currently unstable and will crash often making the keyboard unresponsive to the host
- If this happens, the keyboard can be reset by pressing
CIRCLE + HYPER + R - The keyboard can be putting flashing mode by pressing
CIRCLE + HYPER + X
- Reform device tree and pinctrl
- Keyboard matrix and function layers
- RGB - WS2812 driver on PIO0
- Display - Custom Display Code
- does not use ZMK's display widgets
- Settings saving & loading
- Physical keyboard layout definition
- ZMK Studio Support
- Trackball, Trackpad support
- MNT Reform system controller support
- MNT Reform Pocket support
- Download the most recent build from the GitHub Actions tab
- Follow the standard ZMK documentation to setup a native toolchain
- Use the work in progress branch of ZMK that ports it to Zephyr 4.1 core/move-to-zephyr-4-1
- Build from within the ZMK repository using a command like the following, pointing to this repository as an extra module:
west build -p -b reform -- -DZMK_EXTRA_MODULES=/some/path/zmk-mntre-module
With ZMK Studio support enabled:
west build -p -b reform -S studio-rpc-usb-uart -- -DZMK_EXTRA_MODULES="/home/jogu/projects/zmk-mntre-module" -DCONFIG_ZMK_STUDIO=y
- Currently, the UART port normally used for the system controller communication is being used as a UART console.
sudo minicom -D /dev/ttyACM1 -b 11520
- MNT Reform Shop link for this keyboard
- Official Firmware Source
- Keyboard PCB Source
- Keyboard Schematic
SPDX-License-Identifier: GPL-3.0-or-later