# nfaz10/nf_eos_keypad architecture

> Architecture diagram of the GitHub repository nfaz10/nf_eos_keypad, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nfaz10/nf_eos_keypad
- Repository: https://github.com/nfaz10/nf_eos_keypad

## Overview

This repository documents a work-in-progress physical keyboard project. Its README identifies the Arduino archive, PCB Gerbers, keycap model, and two enclosure models, and lists the intended electronics and switches. The available files do not expose source excerpts, so the graph reflects only those documented artifact and parts relationships; it does not infer firmware behavior, wiring, or assembly flow.

Main entry points: [`README.md`](https://github.com/nfaz10/nf_eos_keypad/blob/main/README.md) (EOS Keyboard), [`EOS_KeyPad-NFAZIO.zip`](https://github.com/nfaz10/nf_eos_keypad/blob/main/EOS_KeyPad-NFAZIO.zip) (PCB Gerbers), [`EOSKEYS.3mf`](https://github.com/nfaz10/nf_eos_keypad/blob/main/EOSKEYS.3mf) (Keycaps model), [`EosBack.stl`](https://github.com/nfaz10/nf_eos_keypad/blob/main/EosBack.stl) (Back model)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_electronics["Electronics"]
  node_gerbers["PCB Gerbers"]
  node_esp32["ESP32-S3<br/>[README.md]"]
  node_encoders["Encoders<br/>[README.md]"]
  node_switches["Cherry MX keys<br/>[README.md]"]
  node_diode["Diode<br/>[README.md]"]
end

subgraph group_physical_design["Physical design"]
  node_keycaps["Keycaps model<br/>[EOSKEYS.3mf]"]
  node_back["Back model<br/>[EosBack.stl]"]
  node_face["Face model<br/>[EosFace.stl]"]
end

subgraph group_firmware["Firmware"]
  node_arduino["Arduino files<br/>[EOSKEYBOARD.zip]"]
end

node_builder(("Keyboard builder"))
node_keyboard["EOS Keyboard<br/>[README.md]"]

node_keyboard -->|"provides firmware"| node_arduino
node_keyboard -->|"provides PCB files"| node_gerbers
node_keyboard -->|"provides keycaps"| node_keycaps
node_keyboard -.->|"provides model"| node_back
node_keyboard -.->|"provides model"| node_face
node_keyboard -->|"lists part"| node_esp32
node_keyboard -->|"lists parts"| node_encoders
node_keyboard -->|"lists parts"| node_switches
node_keyboard -->|"lists part"| node_diode

click node_keyboard "https://github.com/nfaz10/nf_eos_keypad/blob/main/README.md"
click node_arduino "https://github.com/nfaz10/nf_eos_keypad/blob/main/EOSKEYBOARD.zip"
click node_gerbers "https://github.com/nfaz10/nf_eos_keypad/blob/main/EOS_KeyPad-NFAZIO.zip"
click node_esp32 "https://github.com/nfaz10/nf_eos_keypad/blob/main/README.md"
click node_encoders "https://github.com/nfaz10/nf_eos_keypad/blob/main/README.md"
click node_switches "https://github.com/nfaz10/nf_eos_keypad/blob/main/README.md"
click node_diode "https://github.com/nfaz10/nf_eos_keypad/blob/main/README.md"
click node_keycaps "https://github.com/nfaz10/nf_eos_keypad/blob/main/EOSKEYS.3mf"
click node_back "https://github.com/nfaz10/nf_eos_keypad/blob/main/EosBack.stl"
click node_face "https://github.com/nfaz10/nf_eos_keypad/blob/main/EosFace.stl"

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_gerbers,node_esp32,node_encoders,node_switches,node_diode toneBlue
class node_keycaps,node_back,node_face toneAmber
class node_arduino toneMint
class node_builder toneIndigo
class node_keyboard toneTeal
```

## Components

### Electronics

- [PCB Gerbers](https://github.com/nfaz10/nf_eos_keypad/blob/main/EOS_KeyPad-NFAZIO.zip): `EOS_KeyPad-NFAZIO.zip`
- [ESP32-S3](https://github.com/nfaz10/nf_eos_keypad/blob/main/README.md): `README.md`
- [Encoders](https://github.com/nfaz10/nf_eos_keypad/blob/main/README.md): `README.md`
- [Cherry MX keys](https://github.com/nfaz10/nf_eos_keypad/blob/main/README.md): `README.md`
- [Diode](https://github.com/nfaz10/nf_eos_keypad/blob/main/README.md): `README.md`

### Physical design

- [Keycaps model](https://github.com/nfaz10/nf_eos_keypad/blob/main/EOSKEYS.3mf): `EOSKEYS.3mf`
- [Back model](https://github.com/nfaz10/nf_eos_keypad/blob/main/EosBack.stl): `EosBack.stl`
- [Face model](https://github.com/nfaz10/nf_eos_keypad/blob/main/EosFace.stl): `EosFace.stl`

### Firmware

- [Arduino files](https://github.com/nfaz10/nf_eos_keypad/blob/main/EOSKEYBOARD.zip): `EOSKEYBOARD.zip`

### Other components

- **Keyboard builder**
- [EOS Keyboard](https://github.com/nfaz10/nf_eos_keypad/blob/main/README.md): `README.md`

## Connections

- EOS Keyboard → Arduino files: provides firmware (evidence: `README.md`)
- EOS Keyboard → PCB Gerbers: provides PCB files (evidence: `README.md`)
- EOS Keyboard → Keycaps model: provides keycaps (evidence: `README.md`)
- EOS Keyboard → Back model: provides model
- EOS Keyboard → Face model: provides model
- EOS Keyboard → ESP32-S3: lists part (evidence: `README.md`)
- EOS Keyboard → Encoders: lists parts (evidence: `README.md`)
- EOS Keyboard → Cherry MX keys: lists parts (evidence: `README.md`)
- EOS Keyboard → Diode: lists part (evidence: `README.md`)
