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 and powerful firmware that is designed for power-efficiency, flexibility, and broad hardware support. ZMK is capable of being used for both wired and wireless input devices.
Features
Below table lists major features/capabilities currently supported in ZMK, as well as ones that are currently under development and not planned.
| Legend: | ✅ Supported | 🚧 Under Development | ❌ Not Planned |
|---|
| Hardware | Support |
|---|---|
| Wireless Split Keyboards | ✅ |
| Wired Split Keyboards | 🚧 |
| Low Active Power Usage | ✅ |
| Encoders | ✅ |
| LED-based Lighting | ✅ |
| Displays | 🚧 |
| Pointing Devices | ✅ |
| Multitouch Touchpads (PTP) | 🚧 |
| Low Power Sleep States | ✅ |
| Low Power Mode (VCC Shutoff) for Peripherals | ✅ |
| Improved Power Handling for Multiple Peripherals | 🚧 |
| Battery Level Reporting | ✅ |
| Support for a Wide Range of 32-bit Microcontrollers | ✅ |
| Support for AVR/8-bit Chips | ❌ |
| Connectivity | Support |
|---|---|
| Low-Latency BLE Support | ✅ |
| Multi-Device BLE Connectivity | ✅ |
| USB Connectivity | ✅ |
| Keymap Features | Support |
|---|---|
| User Configuration Repositories | ✅ |
| Keymaps and Layers | ✅ |
| Wide Range of Keycodes | ✅ |
| Flexible Behavior System | ✅ |
| Hold-Taps (including Mod-Tap and Layer-Tap) | ✅ |
| Tap-Dances | ✅ |
| Sticky (One Shot) Keys | ✅ |
| Combos | ✅ |
| Macros | ✅ |
| Mouse Keys | ✅ |
| Realtime Keymap Updating | 🚧 |
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.