How kellman88/adv360-pro-zmk works
This project is a configuration repository for the Kinesis Advantage 360 Pro firmware – a customized fork of the ZMK keyboard firmware. Its primary purpose is to provide board-specific keymap configurations and device settings (like RGB effects, NKRO, battery reporting, etc.), along with build automation and firmware packaging for a split keyboard (left/right modules). The repository integrates a local build system and GitHub Actions for continuous integration, and it also links to an external web GUI for editing keymaps.
Main Components
• Build & Automation Layer: Show the Makefile execution and Dockerfile usage supported by scripts in the ‘bin’ directory. GitHub workflows (in .github/workflows) serve as the cloud-based CI/CD environment.
• Firmware Artifacts: Indicate where compiled output is stored (the ‘firmware’ directory) and how the binaries (for left and right modules) are produced from the configuration.
• External Interfaces & Documentation: Include the web-based GUI (for keymap editing) and related external documentation resources from Kinesis and ZMK. Also represent support interfaces like upgrade documents (UPGRADE.md) and changelogs.
• Versioning & Update Process: Emphasize the integration of version tracking (e.g., Git commit hash, build timestamp) as described in the README, and how users are guided to upgrade firmware.
Relationships & Data Flow
• External user interactions: the GUI for keymap editing and the instructions for flashing (which include bootloader modes and USB flashing) as separate nodes communicating with the firmware output.
Architectural Patterns & Design Principles
• Modular Design: Separate directories indicate clear separation of concerns – configuration, build scripts, assets, and CI workflows are all isolated into their sections. Each module (left/right firmware, keymap definitions, board configurations) should be distinct.
• CI/CD Integration: Emphasize the GitHub Actions automated build process described in the README, supporting continuous integration practices.
• Containerization: Include the role of Docker (or Podman) and Make for ensuring repeatable builds across environments.
• Versioning: Clearly denote that version metadata (compilation date, branch, commit hash) is embedded into firmware during the build process, reinforcing traceability.