Preamble
For normal use, you can configure your keyboard by going to keyboard.frame.work. Flashing or building firmware is not necessary, and it does carry risk. If you kill your keyboard, I presume it’s not covered by warranty.
• Keyboard QMK firmware, getting the right files to build.
This is only for the Framework 16. The Framework 13 does not use QMK.
I’ve seen a couple people unsure where to get the right branch to compile the firmware.
It’s presumed that you already have your QMK build environment setup. If not, follow this docs.qmk.fm/#/newbs_getting_started Running qmk doctor should say that QMK is ready to go.
Download the Framework Firmware repo
- Check the version number of the latest release https://github.com/FrameworkComputer/qmk_firmware/releases
- Click the “tags” button on that page to confirm that a branch corresponding to the latest release is there github.com/FrameworkComputer/qmk_firmware/tags
- Clone that particular branch with
git clone -b <branchname> <remote-repo-url>
For example:
git clone -b v0.2.9 https://github.com/FrameworkComputer/qmk_firmware.git
QMK compiles from its home directory. See it’s current home directory with
qmk config user.qmk_home
If the Framework firmware repo got downloaded to a different location, you can either move the folder, or just point QMK to it
To point QMK to it / change QMK’s home directory
qmk config user.qmk_home=/[Path-To-The-Downloaded-Firmware]/
• Flashing / reflashing the Framework 16 keyboard firmware.
Be sure you have an external keyboard. Your keyboard won’t work if the wrong file or a bad file is flashed.
To flash firmware, you need to restart your keyboard or numpad into bootloader mode. Here are 3 options:
- On Framework Laptop 16 Keyboard: Hold down left ALT and right ALT while
installing the module- On Framework Laptop 16 Numpad: Hold down keys for 2 and 6 while installing the
module- Bootmagic reset: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
- Keycode in layout: Press the key mapped to QK_BOOT if it is available
The QK_BOOT key is named Reset in Via (https://keyboard.frame.work). It’s found in the “Special” section. Just place it on any key, then press the key.
When your keyboard enters bootloader mode, it will appear to your computer as a flash drive.
To flash or reflash a .uf2 firmware file, open the drive just like you would a real flash drive. Then just drag-and-drop the appropriate .uf2 file over to it. For example, framework_ansi_default_v0.2.9.uf2 for the ANSI (American) layout keyboard. Your keyboard will restart automatically and run the new firmware.
Which layout do I want? ANSI, ISO or JIS
ANSI (American) layout. Note the shape of the enter key.
ISO layout. British is shown, but this layout is valid for many languages.
JIS (Japanese) layout.
Official Framework .uf2 firmware files are here github.com/FrameworkComputer/qmk_firmware/releases
If you’re flashing firmware that you complied yourself, you would usually just do that by command line, rather than dragging-and-dropping the file.
• Compile and flashing commands.
First, cleanup any files from previous builds. It saves you from problems. I always do this by just adding it in front of flashing or compile commands with &&. For example: qmk clean && qmk flash -kb framework/macropad -km default
qmk clean
Compile, creating a .uf2 file in your current directory. For example: qmk compile -kb framework/macropad -km default
qmk compile -kb framework/[KEYBOARD] -km [KEYMAP]
Compile and flash straight over. If your keyboard isn’t already in bootloader mode, QMK will kindly wait for you to do that at the end of the compiling process. A .uf2 file will also still be created in your current directory.
qmk flash -kb framework/[KEYBOARD] -km [KEYMAP]
Also, here is a Per-key color step-by-step
How to get to point you can have per key RGB control for keyboard and macropad? - #2 by MJ1