Flashing firmware

Depending on your microcontroller and preference, there are three possible firmware options: QMK, Vial or ZMK.

• Choose QMK or Vial when you're using a wired controller such as the Liatris, Elite-Pi, Elite-C or Pro Micro.
• Choose ZMK when using a wireless controller such as the nice!nano.

QMK or Vial

To start with, use our precompiled firmware files. Use our Firmware Finder to find the right file for you. These precompiled files are easy to install and known to work, which are great for testing the keyboard you've just built.

We recommend starting out with Vial. It allows you to configure your keyboard using the website vial.rocks or the Vial application (Windows, Mac and Linux) on your computer later on. For now you'll only have to download and then flash the file.

With the firmware file downloaded, the instructions to flash it to your microcontroller will vary depending on which microcontroller you are using:

• Flashing a Liatris controller
• Flashing an Elite-Pi controller
• Flashing an Elite-C controller
• Flashing a Pro Micro controller

Building QMK locally

First, install the QMK client by following the steps listed on the QMK Setup page.

The command needed to compile your firmware file differ depending on the controller used. In the examples below, we're building firmware for the Aurora Corne using the debug keymap. You can change their names to match your keyboard and keymap.

Liatris

qmk compile -e CONVERT_TO=liatris -kb splitkb/aurora/corne -km debug

If you do not want to specify the converter every time, add the following to your keymap's rules.mk file:

CONVERT_TO=liatris

Elite-Pi

qmk compile -e CONVERT_TO=elite_pi -kb splitkb/aurora/corne -km debug

If you do not want to specify the converter every time, add the following to your keymap's rules.mk file:

CONVERT_TO=elite_pi

Elite-C

qmk compile -kb splitkb/aurora/corne -km debug

Pro Micro

qmk compile -e BOOTLOADER=caterina -kb splitkb/aurora/corne -km debug

If you do not want to specify the bootloader every time, add the following to your keymap's rules.mk file:

BOOTLOADER = caterina

Building QMK online

It's possible to build QMK firmware using QMK's online configurator. We don't recommend this, however, as it is currently hardcoded to compile the Elite-C firmware for Aurora keyboards. It is simpler and more convenient to instead use Vial in the meantime, or build your QMK firmware locally.

ZMK

To start with, you can use our Firmware Finder to find the right file for you. These precompiled files are easy to install and known to work, which are great for testing the keyboard you've just built.

To flash your microcontroller, you can use the instructions at Flashing a nice!nano controller.

Building ZMK firmware

Building your own ZMK firmware has not yet been documented by splitkb.com. In the meantime, you can follow the steps on the Installing ZMK page. For most Aurora keyboards, you can select your keyboard during the setup process. If your keyboard has just recently been released, you can request further directions on our Discord server.