# Firmware Download and Update Guide

This guide will walk you through the process of upgrading or flashing firmware on your Pikatea device. The QMK_Toolbox runs only on Windows and Mac OS X. For Linux, have a look at the pointers at the bottom of this page.

# Download Firmware

The firmware download page contains updated firmware files for all Pikatea products. Download the firmware you'd like (.hex file) and remember where it is downloaded.

# Pikatea Macropad GB3

# Pikatea Macropad FK1

# FinnGus Keyboard Kit

# Pikatea Macropad R26

# Pikatea Macropad Custom

# 3 Encoders
# 2 Encoders
# 1 Encoder

# Macropad1x5

# Pikatea Macropad GB2

# Pikatea Macropad GB1

# Download QMK_Toolbox

Download the program QMK_toolbox which is used to flash the firmware file on the device. Go to the download page (opens new window) and get version 0.0.21 located under "Assets" (not the beta or 0.1.0 which seems to have hickups at the moment).

# Configure QMK_Toolbox

After downloading QMK_Toolbox, open it and make sure the following settings are set.

  1. Set MCU (AVR only) to atmega32u4.
  2. Set Auto-Flash to checked
  3. Click "open" to set the local file to the firmware downloaded earlier (.hex file) It should look something like this:

# Flash Firmware

Connect the device to the computer. Your device might start flashing automatically. Otherwise, wait for the computer to recognize the device. Press the reset button which is usually the small button located on the back of the device or connect the RST and GND pins on the Pro Micro if your device uses one. This will put the device into it's flashing mode.

some Pro Micros can be stubbern and take several several tries to get into flashing mode

OR

The device will disconnect and then reconnect in DFU mode. QMK_Toolbox will recognize the device in DFU mode and start flashing the firmware. If you have issues, try restarting QMK_Toolbox and trying again. Try several times, sometimes devices can have a hard time going into DFU mode. If auto-flash is giving you issues, you can manually click flash. Just do so when the device has been reset and is in DFU mode. If you use linux, try holding down the reset button as you plug in the device instead.

That's it! You should have a result that looks like one of the following 2 images.

OR

# Linux instructions

With linux you can download a compatible firmware and flash it directly with avrdude:

avrdude -p atmega32u4 -c avr109 -P /dev/ttyACM0 -U flash:w:macropad1x5_vial.hex:i

Make sure to enter the correct port and path to the .hex on your machine. Prepending sudo or adjusting the udev rules may be required. You only need to flash the firmware once and can use Vial from then on.

# Firmware Repo

Most of our firmware is compiled with Vial-QMK. Our fork is located here https://github.com/JackPikatea/vial-qmk (opens new window). It is backwards compatible with QMK.