Zephyr™ Mechanical Keyboard (ZMK) Firmware

English | 简体中文

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.

Building Firmware for the SiFli SF32 Platform

This fork adds support for the SiFli SF32LB52 (SF32LB525) DevKit.

For setting up the build environment (native toolchain and workspace initialization), please refer to the official ZMK documentation: Local Native Toolchain Setup.

All build commands must be run from the app/ subdirectory.

Build

Build each half of the urchin_sf32lb52 split keyboard for the sf32lb52_devkit_lcd board (SoC variant sf32lb525uc6/zmk):

# Left half
west build -b sf32lb52_devkit_lcd/sf32lb525uc6/zmk -d build/left -- -DSHIELD=urchin_sf32lb52_left

# Right half
west build -b sf32lb52_devkit_lcd/sf32lb525uc6/zmk -d build/right -- -DSHIELD=urchin_sf32lb52_right

Flash

west flash -d build/left -- --port COMxx
west flash -d build/right -- --port COMxx

west flash uses the SiFli sftool runner and flashes both the firmware image and the bootloader flash table (ftab) in one go. Replace COMxx with the serial port of the board (e.g. COM3).

Generated files in each build directory:

• Firmware image: build/<half>/zephyr/zmk.hex
• Flash table (ftab): build/<half>/zephyr/sf32lb52x_ftab.hex