# crealityofficial/creality_sonic_pad architecture

> Architecture diagram of the GitHub repository crealityofficial/creality_sonic_pad, 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/crealityofficial/creality_sonic_pad
- Repository: https://github.com/crealityofficial/creality_sonic_pad

## Overview

This repository provides Sonic Pad printer configurations and guidance for building and installing Klipper firmware. Its practical workflow is to select a model configuration, copy it to USB, and boot the custom model; the pad then maps the MCU serial address to the connected USB port. The README also documents manually correcting that address when using Fluidd’s configuration option. It describes configuring and building firmware, then installing it by SD/TF card or USB. The tree names Fluidd, Mainsail, Moonraker, and Klipper directories, but no source excerpts were provided, so their internal behavior and connections are not inferred.

Main entry points: [`README.md`](https://github.com/crealityofficial/creality_sonic_pad/blob/main/README.md) (Firmware build), [`printer_configrations`](https://github.com/crealityofficial/creality_sonic_pad/tree/main/printer_configrations) (Model configs), [`printer_configrations/moonraker`](https://github.com/crealityofficial/creality_sonic_pad/tree/main/printer_configrations/moonraker) (Moonraker configs), [`klipper`](https://github.com/crealityofficial/creality_sonic_pad/tree/main/klipper) (Klipper firmware)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_configs["Printer configuration"]
  node_modelcfg["Model configs"]
  node_mooncfg["Moonraker configs"]
end

subgraph group_firmware["Firmware build and install"]
  node_klipper["Klipper firmware"]
  node_build["Firmware build<br/>[README.md]"]
  node_install["Firmware install<br/>[README.md]"]
end

subgraph group_interfaces["Pad interfaces"]
  node_moonraker["Moonraker"]
  node_fluidd["Fluidd"]
  node_mainsail["Mainsail"]
  node_pad["Sonic Pad"]
end

node_user(("Printer owner"))
node_usbdrive["USB drive"]
node_printer["Printer MCU"]

node_user -->|"selects model"| node_modelcfg
node_user -->|"copies config"| node_usbdrive
node_usbdrive -->|"boots custom model"| node_pad
node_pad -->|"maps serial address"| node_printer
node_user -->|"overwrites config"| node_fluidd
node_user -->|"uses port config"| node_mooncfg
node_user -->|"configures and builds"| node_build
node_build -->|"generates firmware"| node_klipper
node_user -->|"installs firmware"| node_install
node_install -->|"flashes firmware"| node_printer

click node_modelcfg "https://github.com/crealityofficial/creality_sonic_pad/tree/main/printer_configrations"
click node_mooncfg "https://github.com/crealityofficial/creality_sonic_pad/tree/main/printer_configrations/moonraker"
click node_klipper "https://github.com/crealityofficial/creality_sonic_pad/tree/main/klipper"
click node_build "https://github.com/crealityofficial/creality_sonic_pad/blob/main/README.md"
click node_install "https://github.com/crealityofficial/creality_sonic_pad/blob/main/README.md"
click node_moonraker "https://github.com/crealityofficial/creality_sonic_pad/tree/main/moonraker_ys"
click node_fluidd "https://github.com/crealityofficial/creality_sonic_pad/tree/main/fluidd_ys"
click node_mainsail "https://github.com/crealityofficial/creality_sonic_pad/tree/main/mainsail_ys"

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_modelcfg,node_mooncfg toneBlue
class node_klipper,node_build,node_install toneAmber
class node_moonraker,node_fluidd,node_mainsail,node_pad toneMint
class node_user,node_usbdrive,node_printer toneIndigo
```

## Components

### Printer configuration

- [Model configs](https://github.com/crealityofficial/creality_sonic_pad/tree/main/printer_configrations): `printer_configrations`
- [Moonraker configs](https://github.com/crealityofficial/creality_sonic_pad/tree/main/printer_configrations/moonraker): `printer_configrations/moonraker`

### Firmware build and install

- [Klipper firmware](https://github.com/crealityofficial/creality_sonic_pad/tree/main/klipper): `klipper`
- [Firmware build](https://github.com/crealityofficial/creality_sonic_pad/blob/main/README.md): `README.md`
- [Firmware install](https://github.com/crealityofficial/creality_sonic_pad/blob/main/README.md): `README.md`

### Pad interfaces

- [Moonraker](https://github.com/crealityofficial/creality_sonic_pad/tree/main/moonraker_ys): `moonraker_ys`
- [Fluidd](https://github.com/crealityofficial/creality_sonic_pad/tree/main/fluidd_ys): `fluidd_ys`
- [Mainsail](https://github.com/crealityofficial/creality_sonic_pad/tree/main/mainsail_ys): `mainsail_ys`
- **Sonic Pad**

### Other components

- **Printer owner**
- **USB drive**
- **Printer MCU**

## Connections

- Printer owner → Model configs: selects model (evidence: `README.md`)
- Printer owner → USB drive: copies config (evidence: `README.md`)
- USB drive → Sonic Pad: boots custom model (evidence: `README.md`)
- Sonic Pad → Printer MCU: maps serial address (evidence: `README.md`)
- Printer owner → Fluidd: overwrites config (evidence: `README.md`)
- Printer owner → Moonraker configs: uses port config (evidence: `README.md`)
- Printer owner → Firmware build: configures and builds (evidence: `README.md`)
- Firmware build → Klipper firmware: generates firmware (evidence: `README.md`)
- Printer owner → Firmware install: installs firmware (evidence: `README.md`)
- Firmware install → Printer MCU: flashes firmware (evidence: `README.md`)
