2020-05-25 18:33:21 -07:00
---
title: Introduction to ZMK
sidebar_label: Introduction
2020-10-19 13:41:57 -07:00
slug: /
2020-05-25 18:33:21 -07:00
---
2020-06-09 06:52:26 -07:00
ZMK Firmware is an open source (MIT) keyboard
2020-10-10 10:39:36 -07: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-25 18:33:21 -07:00
2020-05-26 08:55:58 -07:00
## Features
2020-10-10 20:40:14 -07: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-08 18:06:20 -07:00
| Legend: | ✅ Supported | 🚧 Under Development | 💡 Planned |
| :------ | :----------- | :------------------- | :--------- |
2021-08-12 16:52:11 -07: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 )) | ✅ | ✅ | ✅ |
| [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 ) | ✅ | ✅ | ✅ |
| One Shot Keys | ✅ | ✅ | ✅ |
| [Combo Keys ](features/combos.md ) | ✅ | | ✅ |
| Macros | 🚧 | ✅ | ✅ |
2021-09-17 04:25:40 -07:00
| Mouse Keys | 🚧 | ✅ | ✅ |
2021-08-12 16:52:11 -07: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-25 10:23:51 -07:00
[^2]: Encoders are not currently supported on peripheral side splits.
[^1]: OLEDs are currently proof of concept in ZMK.
2020-10-09 09:12:10 -07:00
2020-06-10 18:11:49 -07: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.