zmk_mf68/docs/docs/intro.md

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. Currently, the working bits include:

• Wireless connectivity via BLE HID Over GATT (HOG)
• 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

Missing Features

• One Shot Keys
• Combo keys
• Macros
• Complete split support (encoders and RGB are not supported on the 'peripheral' side)
• Battery reporting
• Low power sleep states
• Low power mode (to toggle LEDs and screen off)
• Shell over BLE

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.