QMK firmware for uConsole keyboard

First release: 20240909

Download: https://files.olly.xyz/qmk/clockworkpi_uconsole_default.20240909.bin

  • Initial working release
  • Adds horizontal and vertical scrolling to the trackball (enabled by holding the “Select” key)
  • Adds Fn+Esc key binding to enter bootloader
  • This is beta firmware - please send feedback if you try it out!

About

This is a port of the original uConsole keyboard firmware to the QMK open-source firmware ecosystem. QMK (Quantum Mechanical Keyboard) is an open source community centered around developing computer input devices. The community encompasses all sorts of input devices, such as keyboards, mice, and MIDI devices.

Installing

Pre-requisites:

  1. Install dfu-util (sudo apt install dfu-util)
  2. Download the stock ClockworkPi keyboard flashing tools (if your keyboard is on stock firmware) https://github.com/clockworkpi/uConsole/raw/master/Bin/uconsole_keyboard_flash.tar.gz
  3. Download the firmware binary from the link at the top of this post

If you’re on stock firmware, QMK can be installed using the stock flash tools:

$ sudo ./maple_upload ttyACM0 2 1EAF:0003 clockworkpi_uconsole_default.20240909.bin

To upgrade from an older QMK firmware, use the following command and hit Fn+Esc when you see the “Waiting for device” prompt.

$ sudo dfu-util -w -d 1eaf:0003 -a 2 -D clockworkpi_uconsole_default.20240909.bin -R

Code

Source for the firmware can be found in my QMK fork on GitHub. The keyboard config can be found in the keyboards/clockworkpi/uconsole directory.

Disclaimer

I’m not affiliated with Clockwork in any way. This is beta software and I can’t offer any guarantee that it works. You take all responsibility if you brick your keyboard using this firmware.

9 Likes

Release: 20240910

Download: http://files.olly.xyz/qmk/clockworkpi_uconsole_default.20240910.bin

Changes

  • Make Fn+Arrow bindings match stock firmware
  • Adds Gamepad mode
    • Gamepad mode can be toggled by Fn+G
    • Gamepad mode re-binds the arrow keys to d-pad buttons
  • Make volume key behavior match stock firmware
  • Change the bootloader binding from Fn+Esc to LeftAlt+RightAlt+Start
    • This is to avoid accidental activation
3 Likes

Great effort and I am ready to try this firmware. But I still have a question, if I brush and don’t continue to use it, how can I restore the official firmware and use the official refresh method?

The dfu-util command above can be used to restore the original factory firmware (which you can compile using the Arduino IDE and the instructions in the GitHub - clockworkpi/uConsole: This code repository offers downloads for the latest images of various uConsole models, along with kernel patches, firmware for the keyboard and 4G expansion module, hardware schematics, assembly instructions, and essential technical documents. repo).

1 Like

Release: 20240915

Download: http://files.olly.xyz/qmk/clockworkpi_uconsole_default.20240915.bin

Changes

  • Switched debouncing algorithm – fewer repeated or stuck keypresses!
2 Likes

Release: 20240922

Download: https://files.olly.xyz/qmk/clockworkpi_uconsole_default.20240922.bin

Changes

  • Added Fn+Esc keyboard lock function, matching factory firmware.
4 Likes

Nice work, I’m going to try this later.

Could I ask about the possibility of using the Rollerball press as the left click instead of middle click?

1 Like

Right now, the best way to customize the layout is to fork the GitHub repo (linked above), edit the config in keyboards/clockworkpi/uconsole and build a new firmware. The mouse buttons are part of the keyboard layout so it’s (relatively) straightforward to remap them.