This repository contains the production firmware for the Ultimate Hacking Keyboard (UHK) family, including the UHK60, UHK80, and companion modules (trackball, trackpoint, keycluster) plus a USB dongle. It implements the complete embedded software stack for a highly configurable split ergonomic keyboard: USB HID and Bluetooth LE HID transport, a rich macro engine with layers, chording, autoshift, sticky modifiers, and secondary roles, per-key RGB backlighting, OLED display with LVGL-based UI, battery management, and inter-device communication (UART, I2C, SPI). The firmware supports two hardware generations via conditional compilation (legacy NXP MCUXpresso SDK on the right half, Zephyr RTOS on the device half and dongle). Architecturally, the codebase is organized into distinct compilation targets: the right-hand keyboard half (right/), the left-hand half and dongle (device/), shared libraries (shared/), and peripheral modules (trackball/, trackpoint/, keycluster/). Central design patterns include an event-driven main loop with an event scheduler, a postponer system for delayed key actions, a versioned binary configuration parser, a lock-free messenger queue for inter-device messaging, and a double-buffered HID report pipeline. The firmware exposes a large USB vendor command set for reconfiguration, debugging, and firmware updates, and includes an embedded test suite that simulates key inputs and validates USB reports. The code demonstrates strong engineering craftsmanship with clean abstractions, extensive use of state machines, and careful resource management in a constrained embedded environment. While the dual-platform support introduces some conditional compilation complexity, the core modules are well-isolated and many patterns (event scheduler, postponer, UART parser, config parser, double buffer) are directly reusable in other embedded projects. The repository is actively maintained with a comprehensive test suite and CI pipeline, though the Zephyr migration is ongoing and some legacy code paths remain.
This repository contains the complete design files, firmware, and assembly instructions for the Redox ergonomic split mechanical keyboard. It is not a software application in the traditional sense but rather an open-source hardware project delivering PCB Gerber/KiCad files, 3D-printable case STLs, precompiled QMK firmware hex files, and detailed build guides for both wired (Rev1.0) and wireless (Rev1.0W, Rev2.0WHS) variants. The code aspect consists of firmware configuration and custom KiCad footprints for keyboard components. The repository serves as a distribution hub for makers to manufacture their own Redox keyboard, with instructions for flashing via avrdude, ST-Link/Docker, and supports multiple firmware ecosystems (QMK, ZMK, KMK). The primary value is in the hardware design and documentation, not in runtime software.