This repository hosts the firmware of the Ultimate Hacking Keyboard.
If you want to use the latest firmware version for your UHK, then instead of going through the pain of building the firmware, simply download the latest release of Agent and update to the latest firmware version within Agent with a click of a button.
If you're one of the brave few who wants to hack the firmware then read on.
- Make sure to clone this repo with:
git clone --recursive git@github.com:UltimateHackingKeyboard/firmware.git
-
Download and install MCUXpresso IDE for Linux, Mac, or Windows.
-
In the IDE, import the project by invoking File -> Import -> General -> Existing Projects into Workspace, select the left or right directory depending on the desired firmware, then click on the Finish button.
For the left keyboard half, make sure to power it via the right keyboard half (which must be powered via USB). Also connect the left keyboard half to your SEGGER J-Link USB debug probe (which must also be connected via USB). Then in KDS, click on Run -> Run Configurations, select GDB SEGGER J-Link Debugging -> uhk60-left_release_jlink, and click on the Debug button.
For the right keyboard half, flash the bootloader first.
At this point, you can flash the right firmware via USB from KDS. To achieve this, you must build Agent that is Git submodule of the this repo and located in the lib/agent directory. Then in KDS, click on Run -> Run Configurations, select C/C++ Application -> uhk60-right_release_kboot, and click on the Run button.
From this point on, you can upgrade the firmwares of both halves via USB by using the uhk60-left_release_kboot and uhk60-right_release_kboot run configurations. Alternatively, you can use your SEGGER J-Link probe.
Want to contribute? Let us show you how.