Skip to content

Install KMK Firmware

Info

This firmware has been tested on CircuitPython (stable) 8.0.3

Reset Button Help

Single push reset button:
Reboot microcontroller - USB drive is called "CIRCUITPY" or e.g. "KLORL"
Double push reset button:
UF2 Bootloader mode - USB drive is called e.g. "RPI-RP2"

1) Install CircuitPython

KMK is a keyboard focused layer that sits on top of CircuitPython.
Follow these steps and then come back here.

2) Rename your microcontroller

Rename your microcontrollers / USB drives to "KLORL" (for the left keyboard side) and "KLORR" (for the right keyboard side) in order for KMK to figure out which side is which.

Follow this tutorial: "Renaming CIRCUITPY through CircuitPython"
OR use these preconfigured boot.py files:

Take utilities/rename_klor_left/boot.py and drag it on your left microcontroller (currently named: "CIRCUITPY")
(available in klor_kmk_firmware.zip or can be manually downloaded here)

Take utilities/rename_klor_right/boot.py and drag it on your right microcontroller (currently named: "CIRCUITPY")
(available in klor_kmk_firmware.zip or can be manually downloaded here)

After a reboot the microcontroller should appear as "KLORL" and "KLORR" respectively.

Image title

3) Install KMK

  1. Get a copy of KMK from the master branch
  2. Unzip and copy the kmk folder and the boot.py file at the root of the USB drive (override the boot.py file used in step 2)
  3. Delete code.py from the USB drive

Image title

3) Install KLOR firmware

  1. Download the kb.py, main.py & the lib folder from klor_kmk_firmware.zip via GitHub releases
  2. Copy the files onto your USB drive
  3. Reboot

Repeat those steps for both the left and right microcontroller.

Image title