pwarren/zmk_mf68
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
zmk_mf68/docs/docs/intro.md
Pete Johanson b7e1509413 Updated intro that better outlines features.
2020-08-03 23:48:17 -04:00

1.1 KiB
Raw Blame History

id title sidebar_label
intro Introduction to ZMK Introduction

ZMK Firmware is an open source (MIT) keyboard firmware built on the Zephyr™ Project RTOS.

The goal is to provider 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 missing more features than it has. Currently, the mostly working bits include:

  • HID Over GATT (HOG) - This is the official term for BLE HID devices
  • Keymaps and layers with basic keycodes
  • Some initial work on one "behavior", Mod-Tap
  • Basic HID over USB
  • Basic consumer (media) keycodes.
  • Basic OLED display logic
  • Basic Split support
  • Encoders

Missing Features

  • One Shot
  • Layer Tap
  • Complete split support
  • Battery reporting
  • Low power mode
  • 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.