mirror of https://github.com/zmkfirmware/zmk.git
3.7 KiB
3.7 KiB
| id | title | sidebar_label |
|---|---|---|
| intro | Introduction to ZMK | Introduction |
ZMK Firmware is an open source (MIT) keyboard firmware built on the Zephyr™ Project Real Time Operating System (RTOS).
The goal is to provide a powerful, featureful keyboard firmware that is free of licensing issues that prevent upstream BLE support as a first-class feature.
Features
At this point, ZMK is still missing many features compared to more developed firmwares such as QMK. Here is a table comparing supported ZMK and QMK features:
| ZMK | QMK | |
|---|---|---|
| Wireless Connectivity via BLE | ✅ | |
| USB Connectivity | ✅ | ✅ |
| Low Active Power Usage | ✅ | |
| Split Keyboard Support | ✅ | ✅ |
| Keymaps and Layers | ✅ | ✅ |
| Hold-tap (which includes mod-tap, layer-tap) | ✅ | ✅ |
| Basic HID over USB | ✅ | ✅ |
| Basic consumer (media) keycodes | ✅ | ✅ |
| Encoders | ✅ | ✅ |
| Basic OLED display support | ✅ | ✅ |
| RGB Underglow | ✅ | ✅ |
| One Shot Keys | ✅ | |
| Combo Keys | ✅ | |
| Macros | ✅ | |
| Mouse Keys | ✅ | |
| Battery Reporting | ||
| Low Power Sleep States | ||
| Low Power Mode (VCC Shutoff) | ||
| Shell over BLE | ||
| AVR/8 Bit | ✅ |
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.