2020-05-26 11:33:21 +10:00
---
title: Introduction to ZMK
sidebar_label: Introduction
2020-10-20 07:41:57 +11:00
slug: /
2020-05-26 11:33:21 +10:00
---
2020-06-09 23:52:26 +10:00
ZMK Firmware is an open source (MIT) keyboard
2020-10-11 04:39:36 +11:00
firmware built on the [Zephyr™ Project ](https://zephyrproject.org/ ) Real Time Operating System (RTOS). ZMK's goal is to provide a modern, wireless, and powerful firmware free of licensing issues.
2020-05-26 11:33:21 +10:00
2020-05-27 01:55:58 +10:00
## Features
2020-10-11 14:40:14 +11:00
ZMK is currently missing some features found in other popular firmware. This table compares the features supported by ZMK, BlueMicro and QMK:
2020-11-12 08:25:32 +11:00
| **Feature** | ZMK | BlueMicro | QMK |
| ------------------------------------------------------------------------------------------------------------------------- | :-: | :-------: | :-: |
| Low Latency BLE Support | ✅ | ✅ | |
| Multi-Device BLE Support | ✅ | | |
2021-02-09 02:48:12 +11:00
| [USB Connectivity ](behaviors/outputs ) | ✅ | ✅ | ✅ |
2020-11-12 08:25:32 +11:00
| User Configuration Repositories | ✅ | | |
| Split Keyboard Support | ✅ | ✅ | ✅ |
| [Keymaps and Layers ](behaviors/layers ) | ✅ | ✅ | ✅ |
| [Hold-Tap ](behaviors/hold-tap ) (which includes [Mod-Tap ](behaviors/mod-tap ) and [Layer-Tap ](behaviors/layers/#layer-tap )) | ✅ | ✅ | ✅ |
| [Keyboard Codes ](codes/#keyboard ) | ✅ | ✅ | ✅ |
| [Media ](codes/#media-controls ) & [Consumer ](codes/#consumer-controls ) Codes | ✅ | ✅ | ✅ |
2021-02-09 02:48:12 +11:00
| [Encoders ](features/encoders )[^1] | ✅ | ✅ | ✅ |
2020-12-31 12:07:03 +11:00
| [Display Support ](features/displays )[^2] | 🚧 | 🚧 | ✅ |
2020-11-12 08:25:32 +11:00
| [RGB Underglow ](features/underglow ) | ✅ | ✅ | ✅ |
2020-12-31 12:07:03 +11:00
| One Shot Keys | ✅ | ✅ | ✅ |
2021-01-24 15:50:30 +11:00
| [Combo Keys ](features/combos ) | ✅ | | ✅ |
2020-11-12 08:25:32 +11:00
| Macros | 🚧 | ✅ | ✅ |
2021-01-05 08:29:55 +11:00
| Mouse Keys | 💡 | ✅ | ✅ |
2020-11-12 08:25:32 +11:00
| Low Active Power Usage | ✅ | | |
2020-12-31 12:07:03 +11:00
| Low Power Sleep States | ✅ | ✅ | |
2021-02-09 02:48:12 +11:00
| [Low Power Mode (VCC Shutoff) ](behaviors/power ) | ✅ | ✅ | |
2020-12-31 12:07:03 +11:00
| Battery Reporting | ✅ | ✅ | |
2021-01-05 08:29:55 +11:00
| Shell over BLE | 💡 | | |
2020-11-12 08:25:32 +11:00
| Realtime Keymap Updating | 💡 | | ✅ |
| AVR/8 Bit | | | ✅ |
| [Wide Range of ARM Chips Supported ](https://docs.zephyrproject.org/latest/boards/index.html ) | ✅ | | |
2020-10-26 04:23:51 +11:00
[^2]: Encoders are not currently supported on peripheral side splits.
[^1]: OLEDs are currently proof of concept in ZMK.
2020-10-10 03:12:10 +11:00
2020-06-11 11:11:49 +10:00
## Code Of Conduct
Please note that this project is released with a
[Contributor Code of Conduct ](https://www.contributor-covenant.org/version/2/0/code_of_conduct/ ).
By participating in this project you agree to abide by its terms.