# gniezen/openpump architecture

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

- Interactive diagram: https://gitdiagram.com/gniezen/openpump
- Repository: https://github.com/gniezen/openpump

## Overview

Openpump is an open-source syringe-pump hardware platform: the user configures and builds the mechanical and electronic device, installs Arduino firmware, and uses the pump to dispense fluid over a set period. The repository contains CAD models, enclosure designs, circuit design files, and firmware assets. The firmware sketch and most design files were not excerpted, so implementation-level connections are limited; the firmware asset header is shown, but its runtime use is not established by the excerpt.

Main entry points: [`firmware/firmware.ino`](https://github.com/gniezen/openpump/blob/master/firmware/firmware.ino) (Arduino Firmware), [`mechanical/linear_actuator_v0.scad`](https://github.com/gniezen/openpump/blob/master/mechanical/linear_actuator_v0.scad) (Actuator CAD), [`schematics/pump-shield`](https://github.com/gniezen/openpump/tree/master/schematics/pump-shield) (Pump Shield Circuit), [`mechanical`](https://github.com/gniezen/openpump/tree/master/mechanical) (Printed Parts)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_mechanical["Pump Mechanics"]
  node_actuator_cad["Actuator CAD"]
  node_printed_parts["Printed Parts"]
end

subgraph group_electronics["Electronics and Firmware"]
  node_firmware["Arduino Firmware<br/>[firmware.ino]"]
  node_ui_assets["UI Assets<br/>[default_assets.h]"]
  node_shield["Pump Shield Circuit"]
end

subgraph group_enclosure["Enclosure Design"]
  node_enclosure_cad["Enclosure CAD"]
end

node_user(("Pump Builder"))
node_arduino["Arduino Mega"]
node_stepper_driver["Stepper Driver"]
node_pump["Syringe Pump"]

node_user -->|"customizes parts"| node_actuator_cad
node_actuator_cad -->|"renders parts"| node_printed_parts
node_user -->|"installs firmware"| node_firmware
node_user -->|"builds electronics"| node_shield
node_firmware -->|"runs on"| node_arduino
node_firmware -.->|"controls dispensing"| node_pump
node_shield -->|"connects components"| node_arduino
node_user -.->|"customizes enclosure"| node_enclosure_cad

click node_firmware "https://github.com/gniezen/openpump/blob/master/firmware/firmware.ino"
click node_ui_assets "https://github.com/gniezen/openpump/blob/master/firmware/default_assets.h"
click node_shield "https://github.com/gniezen/openpump/tree/master/schematics/pump-shield"
click node_actuator_cad "https://github.com/gniezen/openpump/blob/master/mechanical/linear_actuator_v0.scad"
click node_printed_parts "https://github.com/gniezen/openpump/tree/master/mechanical"
click node_enclosure_cad "https://github.com/gniezen/openpump/tree/master/enclosure/scadModel"

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_actuator_cad,node_printed_parts toneBlue
class node_firmware,node_ui_assets,node_shield toneAmber
class node_enclosure_cad toneMint
class node_user,node_arduino,node_stepper_driver,node_pump toneIndigo
```

## Components

### Pump Mechanics

- [Actuator CAD](https://github.com/gniezen/openpump/blob/master/mechanical/linear_actuator_v0.scad): `mechanical/linear_actuator_v0.scad`
- [Printed Parts](https://github.com/gniezen/openpump/tree/master/mechanical): `mechanical`

### Electronics and Firmware

- [Arduino Firmware](https://github.com/gniezen/openpump/blob/master/firmware/firmware.ino): `firmware/firmware.ino`
- [UI Assets](https://github.com/gniezen/openpump/blob/master/firmware/default_assets.h): `firmware/default_assets.h`
- [Pump Shield Circuit](https://github.com/gniezen/openpump/tree/master/schematics/pump-shield): `schematics/pump-shield`

### Enclosure Design

- [Enclosure CAD](https://github.com/gniezen/openpump/tree/master/enclosure/scadModel): `enclosure/scadModel`

### Other components

- **Pump Builder**
- **Arduino Mega**
- **Stepper Driver**
- **Syringe Pump**

## Connections

- Pump Builder → Actuator CAD: customizes parts (evidence: `README.md`)
- Actuator CAD → Printed Parts: renders parts (evidence: `README.md`)
- Pump Builder → Arduino Firmware: installs firmware (evidence: `README.md`)
- Pump Builder → Pump Shield Circuit: builds electronics (evidence: `README.md`)
- Arduino Firmware → Arduino Mega: runs on (evidence: `README.md`)
- Arduino Firmware → Syringe Pump: controls dispensing
- Pump Shield Circuit → Arduino Mega: connects components (evidence: `README.md`)
- Pump Builder → Enclosure CAD: customizes enclosure
