# jost-klancnik/split-keyboard architecture

> Architecture diagram of the GitHub repository jost-klancnik/split-keyboard, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jost-klancnik/split-keyboard
- Repository: https://github.com/jost-klancnik/split-keyboard

## Overview

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: [`Ergogen/output/pcbs`](https://github.com/jost-klancnik/split-keyboard/tree/main/Ergogen/output/pcbs) (KiCad board designs), [`Ergogen/config.yaml`](https://github.com/jost-klancnik/split-keyboard/blob/main/Ergogen/config.yaml) (Ergogen layout), [`Ergogen/output/outlines`](https://github.com/jost-klancnik/split-keyboard/tree/main/Ergogen/output/outlines) (Generated outlines), [`Ergogen/output/cases`](https://github.com/jost-klancnik/split-keyboard/tree/main/Ergogen/output/cases) (Case and plate models)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_design["Layout and Cases"]
  node_layout["Ergogen layout<br/>[config.yaml]"]
  node_mounting["Mounting-hole footprint<br/>[mountinghole.js]"]
  node_outlines["Generated outlines"]
  node_case_models["Case and plate models"]
  node_case_parts["Physical case parts"]
end

subgraph group_electronics["PCB Design"]
  node_pcb_design["KiCad board designs"]
  node_gerbers["Fabrication exports"]
end

subgraph group_firmware["Keyboard Firmware"]
  node_keyboard_config["QMK keyboard config<br/>[config.h]"]
  node_keyboard_core["Keyboard definition<br/>[split_kb_jost.c]"]
  node_default_map["Default keymap<br/>[keymap.c]"]
  node_v1_map["Layered keymap<br/>[keymap.c]"]
  node_qmk["QMK runtime"]
end

node_designer(("Keyboard designer"))
node_fabricator(("PCB fabricator"))
node_assembler(("Keyboard assembler"))
node_halves["Split keyboard halves"]
node_computer(("Host computer"))
node_typist(("Typist"))

node_designer -->|"defines layout"| node_layout
node_layout -->|"generates geometry"| node_outlines
node_mounting -.->|"adds hole footprint"| node_pcb_design
node_outlines -->|"imports geometry"| node_pcb_design
node_designer -->|"routes circuit"| node_pcb_design
node_layout -->|"defines case geometry"| node_case_models
node_case_models -.->|"models parts"| node_case_parts
node_pcb_design -->|"exports fabrication files"| node_gerbers
node_gerbers -->|"sends for manufacture"| node_fabricator
node_fabricator -->|"supplies boards"| node_assembler
node_case_parts -.->|"assembles enclosure"| node_assembler
node_designer -.->|"defines keymap"| node_default_map
node_designer -.->|"defines layers"| node_v1_map
node_keyboard_config -->|"configures"| node_qmk
node_keyboard_core -->|"defines keyboard"| node_qmk
node_default_map -->|"provides keymap"| node_qmk
node_v1_map -->|"provides layers and Unicode"| node_qmk
node_qmk -->|"runs on"| node_halves
node_halves -->|"sends USB input"| node_computer
node_typist -.->|"presses keys"| node_halves

click node_layout "https://github.com/jost-klancnik/split-keyboard/blob/main/Ergogen/config.yaml"
click node_mounting "https://github.com/jost-klancnik/split-keyboard/blob/main/Ergogen/footprints/mountinghole.js"
click node_outlines "https://github.com/jost-klancnik/split-keyboard/tree/main/Ergogen/output/outlines"
click node_case_models "https://github.com/jost-klancnik/split-keyboard/tree/main/Ergogen/output/cases"
click node_case_parts "https://github.com/jost-klancnik/split-keyboard/tree/main/Cases"
click node_pcb_design "https://github.com/jost-klancnik/split-keyboard/tree/main/Ergogen/output/pcbs"
click node_gerbers "https://github.com/jost-klancnik/split-keyboard/tree/main/Ergogen/output/pcbs/garber"
click node_keyboard_config "https://github.com/jost-klancnik/split-keyboard/blob/main/Firmware/split_kb_jost/config.h"
click node_keyboard_core "https://github.com/jost-klancnik/split-keyboard/blob/main/Firmware/split_kb_jost/split_kb_jost.c"
click node_default_map "https://github.com/jost-klancnik/split-keyboard/blob/main/Firmware/split_kb_jost/keymaps/default/keymap.c"
click node_v1_map "https://github.com/jost-klancnik/split-keyboard/blob/main/Firmware/split_kb_jost/keymaps/v1/keymap.c"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_layout,node_mounting,node_outlines,node_case_models,node_case_parts toneBlue
class node_pcb_design,node_gerbers toneAmber
class node_keyboard_config,node_keyboard_core,node_default_map,node_v1_map,node_qmk toneMint
class node_designer,node_fabricator,node_assembler,node_halves,node_computer,node_typist toneIndigo
```

## Components

### Layout and Cases

- [Ergogen layout](https://github.com/jost-klancnik/split-keyboard/blob/main/Ergogen/config.yaml): `Ergogen/config.yaml`
- [Mounting-hole footprint](https://github.com/jost-klancnik/split-keyboard/blob/main/Ergogen/footprints/mountinghole.js): `Ergogen/footprints/mountinghole.js`
- [Generated outlines](https://github.com/jost-klancnik/split-keyboard/tree/main/Ergogen/output/outlines): `Ergogen/output/outlines`
- [Case and plate models](https://github.com/jost-klancnik/split-keyboard/tree/main/Ergogen/output/cases): `Ergogen/output/cases`
- [Physical case parts](https://github.com/jost-klancnik/split-keyboard/tree/main/Cases): `Cases`

### PCB Design

- [KiCad board designs](https://github.com/jost-klancnik/split-keyboard/tree/main/Ergogen/output/pcbs): `Ergogen/output/pcbs`
- [Fabrication exports](https://github.com/jost-klancnik/split-keyboard/tree/main/Ergogen/output/pcbs/garber): `Ergogen/output/pcbs/garber`

### Keyboard Firmware

- [QMK keyboard config](https://github.com/jost-klancnik/split-keyboard/blob/main/Firmware/split_kb_jost/config.h): `Firmware/split_kb_jost/config.h`
- [Keyboard definition](https://github.com/jost-klancnik/split-keyboard/blob/main/Firmware/split_kb_jost/split_kb_jost.c): `Firmware/split_kb_jost/split_kb_jost.c`
- [Default keymap](https://github.com/jost-klancnik/split-keyboard/blob/main/Firmware/split_kb_jost/keymaps/default/keymap.c): `Firmware/split_kb_jost/keymaps/default/keymap.c`
- [Layered keymap](https://github.com/jost-klancnik/split-keyboard/blob/main/Firmware/split_kb_jost/keymaps/v1/keymap.c): `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

- Keyboard designer → Ergogen layout: defines layout (evidence: `README.md`)
- Ergogen layout → Generated outlines: generates geometry (evidence: `README.md`)
- Mounting-hole footprint → KiCad board designs: adds hole footprint
- Generated outlines → KiCad board designs: imports geometry (evidence: `README.md`)
- Keyboard designer → KiCad board designs: routes circuit (evidence: `README.md`)
- Ergogen layout → Case and plate models: defines case geometry (evidence: `README.md`)
- Case and plate models → Physical case parts: models parts
- KiCad board designs → Fabrication exports: exports fabrication files (evidence: `README.md`)
- Fabrication exports → PCB fabricator: sends for manufacture (evidence: `README.md`)
- PCB fabricator → Keyboard assembler: supplies boards (evidence: `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 (evidence: `README.md`)
- Keyboard definition → QMK runtime: defines keyboard (evidence: `README.md`)
- Default keymap → QMK runtime: provides keymap (evidence: `README.md`)
- Layered keymap → QMK runtime: provides layers and Unicode (evidence: `Firmware/split_kb_jost/keymaps/v1/keymap.c`)
- QMK runtime → Split keyboard halves: runs on (evidence: `README.md`)
- Split keyboard halves → Host computer: sends USB input (evidence: `README.md`)
- Typist → Split keyboard halves: presses keys
