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:
2021-06-09 11:06:20 +10:00
| Legend: | ✅ Supported | 🚧 Under Development | 💡 Planned |
| :------ | :----------- | :------------------- | :--------- |
2021-08-13 09:52:11 +10:00
| **Feature** | ZMK | BlueMicro | QMK |
| ---------------------------------------------------------------------------------------------------------------------------------- | :-: | :-------: | :-: |
| Low Latency BLE Support | ✅ | ✅ | |
| Multi-Device BLE Support | ✅ | | |
| [USB Connectivity ](behaviors/outputs.md ) | ✅ | ✅ | ✅ |
| User Configuration Repositories | ✅ | | |
| Split Keyboard Support | ✅ | ✅ | ✅ |
| [Keymaps and Layers ](behaviors/layers.md ) | ✅ | ✅ | ✅ |
| [Hold-Tap ](behaviors/hold-tap.md ) (which includes [Mod-Tap ](behaviors/mod-tap.md ) and [Layer-Tap ](behaviors/layers.md/#layer-tap )) | ✅ | ✅ | ✅ |
2022-03-17 02:06:55 +11:00
| [Tap-Dance ](behaviors/tap-dance.md ) | ✅ | ✅[^3] | ✅ |
2021-08-13 09:52:11 +10:00
| [Keyboard Codes ](codes/index.mdx#keyboard ) | ✅ | ✅ | ✅ |
| [Media ](codes/index.mdx#media-controls ) & [Consumer ](codes/index.mdx#consumer-controls ) Codes | ✅ | ✅ | ✅ |
| [Encoders ](features/encoders.md )[^1] | ✅ | ✅ | ✅ |
| [Display Support ](features/displays.md )[^2] | 🚧 | 🚧 | ✅ |
| [RGB Underglow ](features/underglow.md ) | ✅ | ✅ | ✅ |
2021-10-10 03:25:00 +11:00
| [Backlight ](features/backlight.md ) | ✅ | ✅ | ✅ |
2021-08-13 09:52:11 +10:00
| One Shot Keys | ✅ | ✅ | ✅ |
| [Combo Keys ](features/combos.md ) | ✅ | | ✅ |
2022-04-19 02:44:43 +10:00
| [Macros ](behaviors/macros.md ) | ✅ | ✅ | ✅ |
2021-09-17 21:25:40 +10:00
| Mouse Keys | 🚧 | ✅ | ✅ |
2021-08-13 09:52:11 +10:00
| Low Active Power Usage | ✅ | | |
| Low Power Sleep States | ✅ | ✅ | |
| [Low Power Mode (VCC Shutoff) ](behaviors/power.md ) | ✅ | ✅ | |
| Battery Reporting | ✅ | ✅ | |
| Shell over BLE | 💡 | | |
| 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
2022-03-17 02:06:55 +11:00
[^3]: Tap-Dances are limited to single and double-tap on BlueMicro
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.