# 280zo/charybdis-wireless-mini-3x6-build-guide architecture

> Architecture diagram of the GitHub repository 280zo/charybdis-wireless-mini-3x6-build-guide, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/280zo/charybdis-wireless-mini-3x6-build-guide
- Repository: https://github.com/280zo/charybdis-wireless-mini-3x6-build-guide

## Overview

##### Main Components
- Mechanical/3D Components:
– 3D Print STL Files: This folder contains the case parts (e.g., Left Case, Right Case, Sensor Cover, Adapter parts) and 3D key cap models.
– Magnet Plates: Contains both 2D DXF and 3D STL files, CAD files, and Inkscape files for fabricating the magnetic mounting plates used for tenting.
- PCB and Electronics:
– PCB Gerber Files: Contains the manufacturing files for various PCB components including the PMW3610 breakout, Nano Holder boards, Thumb PCBs, etc.
– Soldering and Assembly Components: Sensor components and discrete components like diodes, capacitors, switches, microcontrollers (SuperMini NRF52840), batteries, and cables.
- Firmware and Integration:
– ZMK Firmware: Documentation and links indicate that the final firmware (blinking and key mapping) is integrated into the keyboard’s operation, with pointers to actions and external repositories.

##### Relationships and Interactions
- The mechanical parts (3D printed case pieces, adapter parts, and keycaps) physically house the electronic PCBs and provide structural support.
- The PCB Gerber files and corresponding electronic components make up the circuit boards that are soldered together by following the detailed assembly guides.
- The sensor (PMW3610) and other sub-modules connect to the microcontrollers (via the Nice!Nano holders), controlled by firmware (loaded from the ZMK repository).
- The magnet plates and tenting accessories link the physical structure to ergonomic enhancements by providing adjustable mounting points.

##### Architectural Patterns & Design Principles
- Modularity and separation: The system is split into distinct modules (mechanical enclosure, electrical PCB components, and firmware/software aspects) that interface in specific ways.
- Clear delineation between design files for manufacturing (CAD/STL/DXF files) and assembly documentation: This separation helps one manage physical production (3D printing, PCB fabrication) apart from assembly instructions and firmware configuration.
- Iterative and community-driven design: The build guide references multiple external guides and repositories, indicating a design that leverages reusable elements from the open-source community.

##### Relevant Technologies, Frameworks, and Tools
- 3D Printing: STL and 3mf files for printing the case parts and keycaps in PETG, white Nylon, or resin.
- CAD Tools: Files in formats like DXF, FCStd (FreeCAD), and Inkscape files for designing magnet plates.
- PCB Fabrication: Gerber files packaged for ordering from services like JLCPCB.
- Firmware: ZMK firmware build instructions and its integration with hardware (MCUs).
- Community Resources: References to BastardKB’s documentation and multiple GitHub repositories.

##### Final Advice
- This breakdown will not only serve as documentation for building the keyboard but also facilitate debugging and iterations on design by clearly reflecting the modular nature of the system.

## Diagram (Mermaid)

```mermaid
graph TD
    subgraph "Mechanical Build"
        M1["3D Printed Case & Key Caps"]:::mechanical
        M2["Magnet Plates & Tenting Accessories"]:::mechanical
    end

    subgraph "Electronics Assembly"
        E1["PCB & Soldered Components"]:::electronics
    end

    subgraph "Firmware Integration"
        F1["Firmware/MCU Integration"]:::firmware
    end

    M1 -->|"houses"| E1
    M2 -->|"supports"| E1
    E1 -->|"firmwareFlashed"| F1
    F1 -->|"MCUControl"| E1

    click M1 "https://github.com/280zo/charybdis-wireless-mini-3x6-build-guide/tree/main/3D Print STL Files"
    click M2 "https://github.com/280zo/charybdis-wireless-mini-3x6-build-guide/tree/main/Magnet Plates"
    click E1 "https://github.com/280zo/charybdis-wireless-mini-3x6-build-guide/tree/main/PCB Gerber Files"
    click F1 "https://github.com/280zo/charybdis-wireless-mini-3x6-build-guide/blob/main/README.md"

    classDef mechanical fill:#ADD8E6,stroke:#333,stroke-width:2px;
    classDef electronics fill:#90EE90,stroke:#333,stroke-width:2px;
    classDef firmware fill:#FFD700,stroke:#333,stroke-width:2px;
```
