User Guide¶
Everything you need to use PinViz day-to-day. Choose a path based on what you want to do.
I want to...¶
Generate a diagram from a config file
→ CLI Usage — pinviz render, output options, themes, complexity limits
Write or edit a YAML configuration → YAML Configuration — full field reference, devices, connections, inline components
Use PinViz from Python code → Python API — programmatic diagram creation
Change diagram colours or use dark mode → Themes — light/dark themes, wire colour overrides
Check my wiring for mistakes before building → Validation — pin conflicts, voltage mismatches, I2C address collisions
Connect devices to other devices (not just the board) → Multi-Level Connections — device-to-device wiring, power chains
Avoid connecting multiple wires to the same GND/power pin
→ Smart Pin Assignment — board_pin_role, automatic distribution
See complete working examples → Examples — examples by board, protocol, and feature
Fix an error I'm seeing → Troubleshooting — common errors and solutions
Reference Pages¶
| Page | Contents |
|---|---|
| CLI Usage | All commands and options |
| YAML Configuration | All config file fields |
| Python API | Programmatic API |
| Themes | Colour themes |
| Validation | Validation checks and safety |
| Multi-Level Connections | Device-to-device wiring |
| Smart Pin Assignment | Automatic pin distribution |
| Examples | Full working examples |
| Troubleshooting | Error reference |