My avatar logoInom Turdikulov

Jan 28, 20232 min read

QMK Firmware

The goal of the QMK software project is to develop a completely customizable, powerful, and enjoyable firmware experience for any project - keyboard or otherwise - and to provide helpful, encouraging, and kind support and feedback for people with any software development experience. TODO: add source

I use QMK on my keyboard (KBD75 rev2). I’have done some basic customizations to keymap. I use Colemak-DH layout (check image below), but on system level (because I use also Russian ЙЦУКЕН layout, so it’s depends on qwerty layout).

-Colemak-DH ANSI Colemak-DH ANSI

Key codes: qmk_firmware/docs/keycodes.md

Flash firmware steps:

  1. Go to directory with QMK firmware cd qmk_firmware

  2. Prepare environment, I have configured NixOS module: qmk.nix.

  3. Run qmk setup, in most situations you will answer y to all questions qmk setup

  4. Test Your Build Environment (firmware can be compiled), kbdfans/kbd75/rev2 is my keyboard. qmk compile -kb kbdfans/kbd75/rev2 -km default

  5. Configure keyboard qmk config user.keyboard=kbdfans/kbd75/rev2

  6. Create keymap and set it as default

qmk new-keymap -km inomoz
qmk config user.keymap=inomoz

Now you have own keymap, you can edit it in keyboards/kbdfans/kbd75/keymaps/inomoz/keymap.c. My layout is here.

  1. Compile and flash Firmware qmk compile -kb kbdfans/kbd75/rev2 -km inomoz

it’s equivalent to qmk compile if keyboard and keymap are set in config.

  1. Flash Firmware qmk flash -kb kbdfans/kbd75/rev2 -km inomoz

it’s equivalent to qmk flash if keyboard and keymap are set in config.

Put Your Keyboard into DFU (Bootloader) Mode, after entering command above. In my case I need to hold ESC and plug USB cable.

More info.

My keymap variant

I have generated PDF file with mine keymap, here is QMK keymap file. To generate it I followed these steps:

  1. Go to directory with QMK firmware cd <path_to_dir>/QMK
  2. Generate keymap.json file
qmk c2json --no-cpp keymap.c >keymap.json # without --no-cpp it might not work
  1. Go to QMK Configurator, upload here keymap.json and print it to PDF ( icon and  icon).

Graph View

Backlinks