Introduction to ZMK

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.

Features

ZMK is currently missing some features found in other popular firmware. This table compares the features supported by ZMK, BlueMicro and QMK:

FeatureZMKBlueMicroQMK
Low Latency BLE Supportโœ…โœ…
Multi-Device BLE Supportโœ…
USB Connectivityโœ…โœ…
User Configuration Repositoriesโœ…
Split Keyboard Supportโœ…โœ…โœ…
Keymaps and Layersโœ…โœ…โœ…
Hold-Tap (which includes Mod-Tap and Layer-Tap)โœ…โœ…โœ…
Keyboard Codesโœ…โœ…โœ…
Media & Consumer Codesโœ…โœ…โœ…
Encoders1โœ…โœ…
OLED Display Support2๐Ÿšง๐Ÿšงโœ…
RGB Underglowโœ…โœ…โœ…
One Shot Keys๐Ÿšงโœ…โœ…
Combo Keys๐Ÿšงโœ…
Macros๐Ÿšงโœ…โœ…
Mouse Keysโœ…โœ…
Low Active Power Usageโœ…
Low Power Sleep States๐Ÿšงโœ…
Low Power Mode (VCC Shutoff)๐Ÿšง
Battery Reporting๐Ÿšงโœ…
Shell over BLE
Realtime Keymap Updating๐Ÿ’กโœ…
AVR/8 Bitโœ…
Wide Range of ARM Chips Supportedโœ…

Code Of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.


  1. Encoders are not currently supported on peripheral side splits.โ†ฉ
  2. OLEDs are currently proof of concept in ZMK.โ†ฉ