Introduction

RMK is a high-performance and feature-rich keyboard firmware framework, designed for flexibility and ease of customization. RMK leverages the power of Rust and its great async Embassy ecosystem, providing comprehensive and modern functionality across a wide range of microcontrollers.

Core Features

  • Broad Microcontroller Support: ESP32, nRF52, nRF54, STM32, RP2040/2350, CYW43(Raspberry Pi Pico W), etc.
  • Wired and Wireless Connectivity: Offers both wired (USB) and wireless (BLE) connections, with optimized low-power performance and multi-profile support.
  • Simple Configuration: Configure your keyboard easily through a single TOML file.
  • On-the-fly Keymap Customization: Change your keymap in real time via Vial (enabled by default) or RMK's native Rynk protocol (experimental).
  • Advanced Feature Set: Packed with modern features, including advanced layer management, powerful macros, multi-role key support (e.g., Tap-Hold, TapDance, Morse Key), display support, hardware watchdog and DFU firmware updates.
  • Split Keyboard Support: Natively supports both wired and wireless split keyboard.

Next Steps