How jost-klancnik/split-keyboard works
This repository documents a wired split ergonomic keyboard, with Ergogen geometry, KiCad PCB design artifacts, case/plate models, and QMK firmware. The main path is layout configuration → generated design assets → PCB fabrication and assembly → firmware on two Pro Micro halves → USB keyboard input. Several generated files are checked in, but the source excerpts do not establish their exact generation wiring; the README supports the high-level design handoffs. Firmware behavior is represented by the two keymaps and the Slovenian Unicode handling in the v1 map.
Main entry points: pcbs KiCad board designs · config.yaml Ergogen layout · outlines Generated outlines · cases Case and plate models
Components 18
Layout and Cases
- Ergogen layout
Ergogen/config.yaml - Mounting-hole footprint
Ergogen/footprints/mountinghole.js - Generated outlines
Ergogen/output/outlines - Case and plate models
Ergogen/output/cases - Physical case parts
Cases
PCB Design
- KiCad board designs
Ergogen/output/pcbs - Fabrication exports
Ergogen/output/pcbs/garber
Keyboard Firmware
- QMK keyboard config
Firmware/split_kb_jost/config.h - Keyboard definition
Firmware/split_kb_jost/split_kb_jost.c - Default keymap
Firmware/split_kb_jost/keymaps/default/keymap.c - Layered keymap
Firmware/split_kb_jost/keymaps/v1/keymap.c - QMK runtime
Other components
- Keyboard designer
- PCB fabricator
- Keyboard assembler
- Split keyboard halves
- Host computer
- Typist
Connections 20
- Keyboard designer → Ergogen layout: defines layout
README.md - Ergogen layout → Generated outlines: generates geometry
README.md - Mounting-hole footprint → KiCad board designs: adds hole footprint
- Generated outlines → KiCad board designs: imports geometry
README.md - Keyboard designer → KiCad board designs: routes circuit
README.md - Ergogen layout → Case and plate models: defines case geometry
README.md - Case and plate models → Physical case parts: models parts
- KiCad board designs → Fabrication exports: exports fabrication files
README.md - Fabrication exports → PCB fabricator: sends for manufacture
README.md - PCB fabricator → Keyboard assembler: supplies boards
README.md - Physical case parts → Keyboard assembler: assembles enclosure
- Keyboard designer → Default keymap: defines keymap
- Keyboard designer → Layered keymap: defines layers
- QMK keyboard config → QMK runtime: configures
README.md - Keyboard definition → QMK runtime: defines keyboard
README.md - Default keymap → QMK runtime: provides keymap
README.md - Layered keymap → QMK runtime: provides layers and Unicode
Firmware/split_kb_jost/keymaps/v1/keymap.c - QMK runtime → Split keyboard halves: runs on
README.md - Split keyboard halves → Host computer: sends USB input
README.md - Typist → Split keyboard halves: presses keys