quick start - alliecatowo/zmk-sofle GitHub Wiki
Quick Start Guide
This guide covers the essential steps to get your AllieCatKeeb up and running with pre-built firmware.
Prerequisites
- AllieCatKeeb keyboard (left and right halves)
- AllieCatKeeb dongle
- USB-C cables
Downloading Firmware
You can find the latest pre-built firmware files in the "Artifacts" section of the most recent build workflow run. You will need to download the all-builds
artifact, which is a ZIP file containing all the necessary .uf2
files.
Flashing Guide
For the most reliable setup, it's best to first flash the settings_reset
firmware to clear any old pairing data, and then flash the main firmware in a specific order.
Step 1: Reset All Devices (Recommended)
- Put your Dongle into bootloader mode by double-tapping its reset button. It will appear as a USB drive.
- Copy the
settings_reset_dongle.uf2
file to the drive. - Repeat for the Left Half with
settings_reset_left.uf2
. - Repeat for the Right Half with
settings_reset_right.uf2
.
Step 2: Flash Main Firmware (Order is Important)
- Flash Dongle First: Put the dongle in bootloader mode and copy
alliecatkeeb_dongle_central.uf2
to it. The dongle needs to be active to accept connections from the keyboard halves. - Flash Left Half: Put the left half in bootloader mode and copy
alliecatkeeb_left_peripheral.uf2
. - Flash Right Half: Put the right half in bootloader mode and copy
alliecatkeeb_right_peripheral.uf2
.
After the final flash, the two halves should automatically find and connect to the dongle. Congratulations, your AllieCatKeeb is ready to use!