Skip to content

export: breadboard SVG visualiser — Phase 2.6 #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
raeq merged 2 commits into from
May 19, 2026
Merged

export: breadboard SVG visualiser — Phase 2.6 #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23d3bbf
export: breadboard SVG visualiser — Phase 2.6 (#28)
May 19, 2026
0dac71b
breadboard: address PR #28 review
May 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,12 @@ Components are stored as `self.<name>` attributes so the framework can auto-coll
| Graphviz DOT | `.dot` | Render to SVG / PNG with `dot -Tsvg` |
| Yosys JSON | `.yosys.json` | Render to a browser-friendly schematic via [netlistsvg](https://github.com/nturley/netlistsvg) |
| Assembly Guide | `.md` | Read at the bench — recipe-style breadboard build instructions |
| Breadboard SVG | `.breadboard.svg` | Open in a browser — the design as it sits on a standard solderless breadboard |
| Net Report | `.net-report.md` | Every logical net, what drives it, what reads it, domain assignment |
| Domain Report | `.domain-report.md` | Every `GroundDomain`, parts in each, where isolation boundaries sit |
| Interface Report | `.interface-report.md` | Every `Board`'s public connector pins and what they connect to |

Every demo in `demos/` ships with all eleven exports pre-generated in its `docs/` subfolder — open any `*.kicad_sch` in Eeschema or any `*.svg` to see the rendered schematic, or any `*.md` to read the bench-assembly guide and the three review reports.
Every demo in `demos/` ships with all twelve exports pre-generated in its `docs/` subfolder — open any `*.kicad_sch` in Eeschema or any `*.svg` to see the rendered schematic, or any `*.md` to read the bench-assembly guide and the three review reports.

## What it prevents

Expand Down
1 change: 1 addition & 0 deletions demos/5v_rail_power/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ The `docs/` folder beside this README has the design's pre-generated exports:

- [`FiveVoltRailPower.bom.csv`](docs/FiveVoltRailPower.bom.csv) — parts list
- [`FiveVoltRailPower.md`](docs/FiveVoltRailPower.md) — breadboard assembly guide
- [`FiveVoltRailPower.breadboard.svg`](docs/FiveVoltRailPower.breadboard.svg) — breadboard layout SVG (open in a browser)
- [`FiveVoltRailPower.net`](docs/FiveVoltRailPower.net) — KiCad netlist
- [`FiveVoltRailPower.kicad_sch`](docs/FiveVoltRailPower.kicad_sch) — KiCad schematic, open in Eeschema 9.x
- [`FiveVoltRailPower.cir`](docs/FiveVoltRailPower.cir) — SPICE deck
Expand Down
1,029 changes: 1,029 additions & 0 deletions demos/5v_rail_power/docs/FiveVoltRailPower.breadboard.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions demos/backup_power/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ The `docs/` folder beside this README has the design's pre-generated exports:

- [`BackupPower.bom.csv`](docs/BackupPower.bom.csv) — parts list
- [`BackupPower.md`](docs/BackupPower.md) — breadboard assembly guide
- [`BackupPower.breadboard.svg`](docs/BackupPower.breadboard.svg) — breadboard layout SVG (open in a browser)
- [`BackupPower.net`](docs/BackupPower.net) — KiCad netlist
- [`BackupPower.kicad_sch`](docs/BackupPower.kicad_sch) — KiCad schematic, open in Eeschema 9.x
- [`BackupPower.cir`](docs/BackupPower.cir) — SPICE deck
Expand Down
13 changes: 13 additions & 0 deletions demos/backup_power/docs/BackupPower.breadboard.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions demos/bldc_motor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ python demos/bldc_motor/bldc_motor.py

The `docs/` folder beside this README has the design's pre-generated exports. The composed `BLDCSystem` gets its own set, and each board (`BLDCControllerBoard`, `BLDCSupplyBoard`) plus the Arduino sketch chip (`Uno_BLDCCommutator`) export as if they were complete designs in their own right:

- [`BLDCSystem.bom.csv`](docs/BLDCSystem.bom.csv), [`BLDCSystem.svg`](docs/BLDCSystem.svg), [`BLDCSystem.md`](docs/BLDCSystem.md), [`BLDCSystem.net`](docs/BLDCSystem.net), [`BLDCSystem.kicad_sch`](docs/BLDCSystem.kicad_sch), [`BLDCSystem.cir`](docs/BLDCSystem.cir), [`BLDCSystem.dot`](docs/BLDCSystem.dot), [`BLDCSystem.mmd`](docs/BLDCSystem.mmd), [`BLDCSystem.yosys.json`](docs/BLDCSystem.yosys.json), [`BLDCSystem.net-report.md`](docs/BLDCSystem.net-report.md), [`BLDCSystem.domain-report.md`](docs/BLDCSystem.domain-report.md), [`BLDCSystem.interface-report.md`](docs/BLDCSystem.interface-report.md) — composed assembly
- [`BLDCControllerBoard.bom.csv`](docs/BLDCControllerBoard.bom.csv), [`BLDCControllerBoard.svg`](docs/BLDCControllerBoard.svg), [`BLDCControllerBoard.md`](docs/BLDCControllerBoard.md), [`BLDCControllerBoard.net`](docs/BLDCControllerBoard.net), [`BLDCControllerBoard.kicad_sch`](docs/BLDCControllerBoard.kicad_sch), [`BLDCControllerBoard.cir`](docs/BLDCControllerBoard.cir), [`BLDCControllerBoard.dot`](docs/BLDCControllerBoard.dot), [`BLDCControllerBoard.mmd`](docs/BLDCControllerBoard.mmd), [`BLDCControllerBoard.yosys.json`](docs/BLDCControllerBoard.yosys.json), [`BLDCControllerBoard.net-report.md`](docs/BLDCControllerBoard.net-report.md), [`BLDCControllerBoard.domain-report.md`](docs/BLDCControllerBoard.domain-report.md), [`BLDCControllerBoard.interface-report.md`](docs/BLDCControllerBoard.interface-report.md) — controller PCB
- [`BLDCSupplyBoard.bom.csv`](docs/BLDCSupplyBoard.bom.csv), [`BLDCSupplyBoard.svg`](docs/BLDCSupplyBoard.svg), [`BLDCSupplyBoard.md`](docs/BLDCSupplyBoard.md), [`BLDCSupplyBoard.net`](docs/BLDCSupplyBoard.net), [`BLDCSupplyBoard.kicad_sch`](docs/BLDCSupplyBoard.kicad_sch), [`BLDCSupplyBoard.cir`](docs/BLDCSupplyBoard.cir), [`BLDCSupplyBoard.dot`](docs/BLDCSupplyBoard.dot), [`BLDCSupplyBoard.mmd`](docs/BLDCSupplyBoard.mmd), [`BLDCSupplyBoard.yosys.json`](docs/BLDCSupplyBoard.yosys.json), [`BLDCSupplyBoard.net-report.md`](docs/BLDCSupplyBoard.net-report.md), [`BLDCSupplyBoard.domain-report.md`](docs/BLDCSupplyBoard.domain-report.md), [`BLDCSupplyBoard.interface-report.md`](docs/BLDCSupplyBoard.interface-report.md) — supply PCB
- [`Uno_BLDCCommutator.bom.csv`](docs/Uno_BLDCCommutator.bom.csv), [`Uno_BLDCCommutator.svg`](docs/Uno_BLDCCommutator.svg), [`Uno_BLDCCommutator.md`](docs/Uno_BLDCCommutator.md), [`Uno_BLDCCommutator.net`](docs/Uno_BLDCCommutator.net), [`Uno_BLDCCommutator.kicad_sch`](docs/Uno_BLDCCommutator.kicad_sch), [`Uno_BLDCCommutator.cir`](docs/Uno_BLDCCommutator.cir), [`Uno_BLDCCommutator.dot`](docs/Uno_BLDCCommutator.dot), [`Uno_BLDCCommutator.mmd`](docs/Uno_BLDCCommutator.mmd), [`Uno_BLDCCommutator.yosys.json`](docs/Uno_BLDCCommutator.yosys.json), [`Uno_BLDCCommutator.net-report.md`](docs/Uno_BLDCCommutator.net-report.md), [`Uno_BLDCCommutator.domain-report.md`](docs/Uno_BLDCCommutator.domain-report.md), [`Uno_BLDCCommutator.interface-report.md`](docs/Uno_BLDCCommutator.interface-report.md) — MCU sketch subassembly
- [`BLDCSystem.bom.csv`](docs/BLDCSystem.bom.csv), [`BLDCSystem.svg`](docs/BLDCSystem.svg), [`BLDCSystem.breadboard.svg`](docs/BLDCSystem.breadboard.svg), [`BLDCSystem.md`](docs/BLDCSystem.md), [`BLDCSystem.net`](docs/BLDCSystem.net), [`BLDCSystem.kicad_sch`](docs/BLDCSystem.kicad_sch), [`BLDCSystem.cir`](docs/BLDCSystem.cir), [`BLDCSystem.dot`](docs/BLDCSystem.dot), [`BLDCSystem.mmd`](docs/BLDCSystem.mmd), [`BLDCSystem.yosys.json`](docs/BLDCSystem.yosys.json), [`BLDCSystem.net-report.md`](docs/BLDCSystem.net-report.md), [`BLDCSystem.domain-report.md`](docs/BLDCSystem.domain-report.md), [`BLDCSystem.interface-report.md`](docs/BLDCSystem.interface-report.md) — composed assembly
- [`BLDCControllerBoard.bom.csv`](docs/BLDCControllerBoard.bom.csv), [`BLDCControllerBoard.svg`](docs/BLDCControllerBoard.svg), [`BLDCControllerBoard.breadboard.svg`](docs/BLDCControllerBoard.breadboard.svg), [`BLDCControllerBoard.md`](docs/BLDCControllerBoard.md), [`BLDCControllerBoard.net`](docs/BLDCControllerBoard.net), [`BLDCControllerBoard.kicad_sch`](docs/BLDCControllerBoard.kicad_sch), [`BLDCControllerBoard.cir`](docs/BLDCControllerBoard.cir), [`BLDCControllerBoard.dot`](docs/BLDCControllerBoard.dot), [`BLDCControllerBoard.mmd`](docs/BLDCControllerBoard.mmd), [`BLDCControllerBoard.yosys.json`](docs/BLDCControllerBoard.yosys.json), [`BLDCControllerBoard.net-report.md`](docs/BLDCControllerBoard.net-report.md), [`BLDCControllerBoard.domain-report.md`](docs/BLDCControllerBoard.domain-report.md), [`BLDCControllerBoard.interface-report.md`](docs/BLDCControllerBoard.interface-report.md) — controller PCB
- [`BLDCSupplyBoard.bom.csv`](docs/BLDCSupplyBoard.bom.csv), [`BLDCSupplyBoard.svg`](docs/BLDCSupplyBoard.svg), [`BLDCSupplyBoard.breadboard.svg`](docs/BLDCSupplyBoard.breadboard.svg), [`BLDCSupplyBoard.md`](docs/BLDCSupplyBoard.md), [`BLDCSupplyBoard.net`](docs/BLDCSupplyBoard.net), [`BLDCSupplyBoard.kicad_sch`](docs/BLDCSupplyBoard.kicad_sch), [`BLDCSupplyBoard.cir`](docs/BLDCSupplyBoard.cir), [`BLDCSupplyBoard.dot`](docs/BLDCSupplyBoard.dot), [`BLDCSupplyBoard.mmd`](docs/BLDCSupplyBoard.mmd), [`BLDCSupplyBoard.yosys.json`](docs/BLDCSupplyBoard.yosys.json), [`BLDCSupplyBoard.net-report.md`](docs/BLDCSupplyBoard.net-report.md), [`BLDCSupplyBoard.domain-report.md`](docs/BLDCSupplyBoard.domain-report.md), [`BLDCSupplyBoard.interface-report.md`](docs/BLDCSupplyBoard.interface-report.md) — supply PCB
- [`Uno_BLDCCommutator.bom.csv`](docs/Uno_BLDCCommutator.bom.csv), [`Uno_BLDCCommutator.svg`](docs/Uno_BLDCCommutator.svg), [`Uno_BLDCCommutator.breadboard.svg`](docs/Uno_BLDCCommutator.breadboard.svg), [`Uno_BLDCCommutator.md`](docs/Uno_BLDCCommutator.md), [`Uno_BLDCCommutator.net`](docs/Uno_BLDCCommutator.net), [`Uno_BLDCCommutator.kicad_sch`](docs/Uno_BLDCCommutator.kicad_sch), [`Uno_BLDCCommutator.cir`](docs/Uno_BLDCCommutator.cir), [`Uno_BLDCCommutator.dot`](docs/Uno_BLDCCommutator.dot), [`Uno_BLDCCommutator.mmd`](docs/Uno_BLDCCommutator.mmd), [`Uno_BLDCCommutator.yosys.json`](docs/Uno_BLDCCommutator.yosys.json), [`Uno_BLDCCommutator.net-report.md`](docs/Uno_BLDCCommutator.net-report.md), [`Uno_BLDCCommutator.domain-report.md`](docs/Uno_BLDCCommutator.domain-report.md), [`Uno_BLDCCommutator.interface-report.md`](docs/Uno_BLDCCommutator.interface-report.md) — MCU sketch subassembly

## Going further

Expand Down
8 changes: 8 additions & 0 deletions demos/bldc_motor/docs/BLDCControllerBoard.breadboard.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions demos/bldc_motor/docs/BLDCSupplyBoard.breadboard.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions demos/bldc_motor/docs/BLDCSystem.breadboard.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading