Skip to content

Changelog

All notable changes to this project are recorded here. The format follows Keep a Changelog, and versions follow Semantic Versioning (before 1.0, a minor version may change the command line).

Unreleased

Fixed

  • existing verify reported a baseline DRC finding as new when only a track's length had changed: KiCad writes length X mm into the item's description, and findings were matched on the full text. The length is now left out of the match (#44).

0.5.1 - 2026-11-15

Fixed

  • Coordinates boardwright wrote were rounded to six significant digits, so any figure of 100 mm or more lost its fourth decimal and beyond: a footprint zone point at 149.119895 became 149.12. KiCad then reported lib_footprint_mismatch on a footprint existing update had added or swapped with --body library (KiCad's Raspberry Pi Pico, with its antenna keep-out, was one). MOVE wrote a position such as 157.1375 as 157.138. Board and schematic coordinates now keep KiCad's 1 nm (#41).

0.5.0 - 2026-11-15

Added

  • existing update swaps a footprint the schematic changed, when the new library footprint's pads are the same as the board's (number, type, shape, position, angle, size, drill, layers). --body keep (the default) changes the library link alone; --body library also takes the drawing from the library. A swap to a footprint whose pads differ is still refused, now with the differences listed (#37).
  • REMOVE = ["G***", "LIB:NAME"] in existing apply takes footprints off the board, by reference or library name. One with a pad on a net or a schematic symbol is refused unless --force (#38).

Fixed

  • A library a project's own table names through ${KICAD10_FOOTPRINT_DIR} or ${KICAD10_SYMBOL_DIR} (as KiCad's demo projects do) was reported as not found by existing update, sch add and sch repoint unless the variable was set in the environment. It now means the stock folder that was found.

0.4.1 - 2026-11-15

Fixed

  • existing apply saved a MOVE through kicad-tools, which rewrote the whole board file (a four-part move: +198 / -5507 lines, nothing lost). A move now edits only the moved footprints' blocks: position, the absolute angles of their pads and texts, and their own zones (#32).

0.4.0 - 2026-11-15

Added

  • A MOVE entry can place the part's reference and value text: {"R10": (25, 25, 270, {"ref": (25.2, 27.4, 0)})} (#25).
  • existing apply checks each part MOVE moves (pads against other nets' copper and the board edge, courtyard against courtyards) and writes nothing on a clash unless given --force; existing free REF [near PAD] lists clear spots for a part (#24).
  • existing update: carry schematic changes to the board, as KiCad's Update PCB from Schematic does, from KiCad's own netlist (the last part of #3). New parts land beside the board on their nets; references, values and pad nets follow the schematic; a footprint swap, a missing footprint or a symbol without one stops it with nothing written. Checked by KiCad's DRC schematic parity.
  • sch add adds on a sub-sheet used once: SHEET = "file.kicad_sch" in the spec (part of #3). Parts take the sheet's hierarchy path; sheet-pin nets get hierarchical labels; power symbols are copied from whichever sheet has one; a net local to another sheet is refused. References are checked across every sheet, not only the root.
  • sch add and sch repoint find a library in KiCad's global sym-lib-table too, after the project's: its path variables (Preferences > Configure Paths, or the environment) are filled in and tables nested in it are followed. KICAD_CONFIG_HOME names KiCad's settings folder; otherwise the newest one in the usual places is used.
  • sch add takes a library symbol LIB:NAME as like, so a part can be added whose symbol the schematic does not use yet (part of #3). Its pins are labelled with the kind of label each net already uses, so add now also works on sheets connected by global labels, such as generated ones.

Changed

  • sch add sizes the free area from each part's pins and labels instead of a fixed 12.7 mm per part, keeps 20 mm from the sheet edge, and turns each power symbol to point away from the part it connects (a +3V3 on a pin that faces down used to be drawn over the part).

Fixed

  • Pad-to-pad routes that share a pad no longer stack a via each at it, 0 to 0.3 mm apart (KiCad's hole_to_hole): a route changes layer on its own net's existing via or through-hole pad without adding one (#23).
  • A preview (place, existing apply, existing info) crashed with exit 2 after the board was written when rsvg-convert was not installed; it now stays SVG, as doctor says.
  • Generated boards now link each footprint to its symbol (path, sheetname, sheetfile), as KiCad does; kicad-tools wrote no link, so renaming a part in the schematic orphaned its placed footprint (#26). The example boards are linked. existing update adds the link when it matches a footprint by reference, like KiCad's re-link.
  • sch add found a cached symbol only if (symbol "LIB:NAME" fit in the first 40 characters of its entry, so a long name such as My_Connector_Library:1217861-1_Tab was refused as not cached.
  • The STM32F103 examples (stm32f103_min, stm32f103_4l) take 100 nF on VDDA, as ST AN2586 Rev 8 section 2.2 asks; they had 10 nF, written from memory (#6). Every example's reference document has now been read.
  • live status names the open board by its full path, and live apply prints that path before it edits, so two copies of a board with the same file name can be told apart (#17).

0.3.1 - 2026-11-15

Fixed

  • sch repoint --body keep onto a symbol the schematic already caches now also compares the cached copy's pin numbers with the library's, and refuses when they differ; it used to move parts onto a stale cached copy silently.

0.3.0 - 2026-11-15

Added

  • boardwright sch DIR repoint OLD_LIB:OLD_NAME NEW_LIB:NEW_NAME [--body keep|library] points every part that uses one library symbol at another, across all sheets, and refuses when the pin numbers differ (#8).

Changed

  • The current review measures how narrow a pour gets between the two pads and fails a pour that necks below the IPC-2221 width, instead of accepting any single piece. Parallel channels are not added together, so a pad fed through thermal spokes measures as one spoke (#5).

Fixed

  • A footprint's own zones (an RF module's antenna keep-out) were left in the library's coordinates when kicad-tools created the board, so they sat beside the part and KiCad reported the footprint as differing from its library. They are now placed with the footprint; KiCad accepts the result at 0, 90 and 180 degrees on top and 0 and 90 on the bottom. The ESP32-C3 example no longer ignores that check (#6; upstream rjwalters/kicad-tools#8958).
  • The LDO example's output capacitor is a 22 uF tantalum, as the AMS1117 datasheet asks for stability; it was a ceramic (#6).

0.2.0 - 2026-11-14

Changed

  • Exit codes follow the heibench contract: 2 when a check cannot be decided (verify with KiCad's reports missing or stale, which used to exit 1), 4 for an environment fault (KiCad, its libraries or Freerouting missing or failing, which used to exit 1), and 64 for usage errors (which used to exit 1, or 2 for an unknown command). An unexpected error exits 2 instead of 1.

Added

  • A documentation site at https://heibench.com/boardwright/.

0.1.0 - 2026-11-14

First public release.

Added

  • boardwright place | gen | check | verify | pads for boards described in a board.py: schematic generation, placement (fixed or by pad intent with pad_at), hand copper (TRACKS, VIAS, ZONES, KEEPOUTS, TEXT), Freerouting with a bottom-layer cost and plane layers closed to it, a pad-to-pad completion pass, pours, and a KiCad gate (ERC, DRC at every severity with schematic parity, netlist, gerbers, drill, BOM, placement, PDF, plots).
  • An engineering review beyond DRC (REVIEW): pad distances, net and path lengths, pair matching with vias counted, reference-plane runs, ground vias beside signal vias, pour coverage and continuity, current capacity per IPC-2221.
  • boardwright existing for boards the tool did not make: inspection and preview of any size of board, review, DRC compared with a baseline, in-place edits (move, rip-up, routes by intent, hand copper), and re-routing of named nets that leaves every other net byte-identical.
  • boardwright sch for schematics: list parts, set fields, remove parts, add a part by copying one with the same symbol, across hierarchical sheets; ercdiff for ERC reports.
  • boardwright live for the board open in KiCad 10 through its IPC API (optional [live] extra), and boardwright edits / selection for plain edit lists and KiCad's selection text.
  • boardwright impedance (IPC-2141 closed form) and doctor.
  • Seven example boards and specs for KiCad's own demo projects.