PinViz

Programmatically generate beautiful Raspberry Pi GPIO connection diagrams in SVG format.

PinViz makes it easy to create clear, professional wiring diagrams for your Raspberry Pi projects. Define your connections using simple YAML/JSON files or Python code, and automatically generate publication-ready SVG diagrams.

See It In Action

Quick Demo - CLI Usage

Python API Demo

Custom Device Demo

Features

• Declarative Configuration: Define diagrams using YAML or JSON
• Programmatic API: Create diagrams with Python code
• Automatic Wire Routing: Smart wire routing with configurable styles (orthogonal, curved, mixed)
• Inline Components: Add resistors, capacitors, and diodes directly on wires
• Color-Coded Wires: Automatic color assignment based on pin function (I2C, SPI, power, ground, etc.)
• Built-in Templates: Pre-configured boards (Raspberry Pi 5 and Pi Zero 2 W) and common devices (BH1750, IR LED rings, etc.)
• GPIO Pin Reference: Optional GPIO pinout diagram for easy reference
• SVG Output: Scalable, high-quality vector graphics

Example Diagrams

LED with Resistor

Simple LED circuit with inline current-limiting resistor:

Multi-Device Setup

BH1750 light sensor + IR LED ring with custom wire colors:

Traffic Light

Three LEDs with individual resistors:

Quick Start

Installation

Using uv (recommended):

uv tool install pinviz

Using pip:

pip install pinviz

Your First Diagram

Create a configuration file my-diagram.yaml:

title: "BH1750 Light Sensor Wiring"
board: "raspberry_pi_5"  # or "raspberry_pi_zero_2w"

devices:
  - type: "bh1750"
    name: "BH1750"

connections:
  - board_pin: 1     # 3V3
    device: "BH1750"
    device_pin: "VCC"

  - board_pin: 6     # GND
    device: "BH1750"
    device_pin: "GND"

  - board_pin: 5     # GPIO3 (I2C SCL)
    device: "BH1750"
    device_pin: "SCL"

  - board_pin: 3     # GPIO2 (I2C SDA)
    device: "BH1750"
    device_pin: "SDA"

Generate the diagram:

pinviz render my-diagram.yaml -o output.svg

Next Steps

• Installation Guide - Detailed installation instructions
• Quick Start Tutorial - Step-by-step guide
• CLI Usage - Command-line interface reference
• Python API - Programmatic usage
• API Reference - Complete API documentation

License

MIT License - See LICENSE for details.

Contributing

Contributions are welcome! See our Contributing Guide for details.