splitkb.com
Firmware - Build Guide

Congratulations with your newly finished Aurora keyboard! 🎉

Testing your keyboard

With the firmware file flashed to your keyboard, now is a good time to test it.

Careful with TRS and TRRS cables. When using TRS or TRRS cables, disconnect the power first before plugging in or unplugging the cable. Not doing so will cause electrical shorts, which can damage your microcontroller.

Testing the keys

To test your keyboard, open up any text editor (or use a tool such as the QMK Configurator test page), and simply press all the keys.

Most of the keys will output something, but some will not. The keys that don't seem to do anything are usually modifiers, but they can also be layer keys. To test these, you may view the layer status on a display you may have installed on your keyboard, or you can press other keys while holding the supposed layer key to see if their output is then different.

Some keys, such as media keys, may depend on the operating system to work, such as previous and next track for which Mac OS has dedicated keycodes.

If you have issues with keys, check out Troubleshooting switches which has all the information on getting your switches back in working order.

Testing the RGB LEDs

It's easy to spot when the LEDs don't work: they either won't turn on, or they'll be in colours you don't expect. Have a look at our Troubleshooting RGB LEDs page to fix any problems you may have with LEDs.

Testing the rotary encoder(s)

Turn it around, press it, see if it does what you expect it to do. If it doesn't work, check out Pressing an encoder doesn't do anything and Fixing encoder skipping in QMK firmware. Just to be sure, assign some "simple" keycodes to the encoder actions to ensure there's no operating system-dependant trickery going on.

Troubleshooting

If you have other issues, please do check out the Troubleshooting section.

If you still have issues or questions afterwards, please refer to Getting help for the best way to get them answered.

Schematics

The schematics for all Aurora kits can be found in the Schematics section. It can be quite useful during troubleshooting!

If you wish to know what changed between revisions, check out the Changelogs section.

Using your keyboard

Each keyboard has a default keymap added to QMK, Vial and ZMK. We recommend you use them as a starting point for your own keymap. Keymaps are highly personal, so don't be afraid to customize yours!

Want to share your thoughts?

This guide as well as the entire experience surrounding it has been built up using suggestions and feedback from people like you.

If you liked building your keyboard and shopping with us, and would like others to also experience that, please consider writing a review over at Trustpilot.

If you have any feedback or questions, please write to support@splitkb.com, or join our Discord server. We'll be able to help you troubleshoot if you have any questions.

I hope you'll enjoy your new keyboard! 🎉


Questions? Help us improve!
Do you have questions after reading the documentation? Do you have feedback about this page, or about the documentation in general? Please send us an email. You can use the buttons below which will open your mail client or app with a template, or send your mail to support@splitkb.com.