NXTKB Ferris Sweep ZMK Config

中文 | English

This repository contains the ZMK firmware configuration for the NXTKB Ferris Sweep keyboard. It is based on the Sweep layout, builds with ZMK, and supports ZMK Studio for live keymap edits when the firmware enables it. Use this repository to inspect, fork, and build firmware. For setup, flashing, keymap diagrams, and day-to-day usage notes, start with the public NXTKB docs.

Official Docs

• Getting Started
• Ferris Sweep Keymap
• Ferris Sweep Configuration
• How to Update Keymaps
• How to Flash Firmware
• Keyboard & Mouse Test

Chinese docs are also available:

• 入门指南
• Ferris Sweep 键位映射
• Ferris Sweep 配置文件

Repository Layout

• config/cradio.keymap: layers, key bindings, home-row modifiers, conditional layers, mouse layer, bootloader keys, soft-off behavior, and ZMK Studio unlock.
• config/cradio.conf: board-level ZMK settings for this keyboard.
• build.yaml: GitHub Actions build matrix for generated firmware artifacts.
• .github/workflows/build.yml: firmware build workflow that reuses ZMK's user config build.

Pinned Dependencies

The firmware build is pinned through config/west.yml:

Project	Remote	Revision
zmk	zmkfirmware/zmk	8feeb52
zmk-behavior-report	nxtkb/zmk-behavior-report	476f43da1f98b4a6150c9c0e499a257bd64a29a0

Firmware and Keymap Workflow

For persistent configuration changes:

1. Fork this repository.
2. Edit config/cradio.keymap or config/cradio.conf.
3. Let GitHub Actions build the firmware artifacts.
4. Flash the generated UF2 file to the matching keyboard half.

For quick keymap edits, use ZMK Studio when this firmware supports it. For the full decision guide, see How to Update Keymaps.

Keymap Summary

The complete diagrams and layer-by-layer explanations live on the website:

• Ferris Sweep Keymap
• Ferris Sweep 键位映射
• View the latest keymap in keymap-drawer

Current default layers:

• Default / Windows layer: character input with home-row modifiers.
• Numbers and navigation layer: hold the right TAB layer key.
• Symbols layer: hold the left TAB layer key.
• Function layer: hold both TAB layer keys for Bluetooth profiles, output switching, Windows-layer toggle, ZMK Studio unlock, and soft off.
• Mouse layer: enter from the symbols layer with SPACE, then leave with P or Q.

Bootloader and Flashing Notes

To enter bootloader mode, use one of these methods:

1. Press the keymap's Boot key while the keyboard is connected.
2. Double-click the reset button.
3. Short RST to GND twice if the reset button is not available.

Firmware artifact names normally indicate the target half:

• left: left half firmware.
• right: right half firmware.
• reset: reset firmware for clearing Bluetooth pairing information.

If you only changed key bindings or the keyboard name, you usually only need to flash the left half. If you changed split behavior, board settings, or right-half behavior, flash the affected half as well. See How to Flash Firmware before updating a board.