ZMK Firmware is an open source (MIT) keyboard firmware built on the Zephyr™ Project Real Time Operating System (RTOS). ZMK's goal is to provide a modern, wireless, and powerful firmware free of licensing issues.

Check out the website to learn more: https://zmk.dev/.

You can also come join our ZMK Discord Server.

To review features, check out the feature overview. ZMK is under active development, and new features are listed with the enhancement label in GitHub. Please feel free to add 👍 to the issue description of any requests to upvote the feature.

Keychron use zmk source code for Bpro series keyboards ,have made big changes fro Bpro, also add proprietary 2.4g communication.

To build the firmware ,for example: keychorn b1 pro

prepare:

    mkdir keychron
    cd keychron
    git clone -b keychron_bpro https://github.com/keychron/zmk.git 
    cd zmk
    west init -l app/
    west update

patch zephyr:

    cd zephyr
    git am ../001-esb-nrf-fix.patch

build firmware:

    cd app
    west build -b keychron -p -- -DSHIELD=keychron_b1_us