traceforge-pcb 1.0.0__py3-none-any.whl

traceforge/kicad/outputs.py

@@ -0,0 +1,81 @@
+"""Fabrication outputs that do not need kicad-cli: BOM and JLCPCB-style CPL."""
+
+from __future__ import annotations
+
+import csv
+from pathlib import Path
+
+from traceforge.kicad.pcb import read_board
+from traceforge.kicad.schematic import _ref_key, read_schematic
+from traceforge.kicad.sides import format_rotation, jlc_rotation, jlc_side
+
+BOM_FIELDS = ("LCSC", "MPN", "Manufacturer")
+
+
+def bom_rows(schematic_path: Path) -> list[dict[str, str]]:
+    """Group components by value, footprint and part numbers."""
+    schematic = read_schematic(schematic_path)
+    groups: dict[tuple, dict] = {}
+    for reference, units in schematic.components().items():
+        symbol = units[0]
+        if not symbol.in_bom:
+            continue
+        key = (
+            symbol.value,
+            symbol.footprint,
+            *(symbol.fields.get(f, "") for f in BOM_FIELDS),
+            symbol.dnp,
+        )
+        group = groups.setdefault(
+            key,
+            {
+                "refs": [],
+                "Value": symbol.value,
+                "Footprint": symbol.footprint,
+                **{f: symbol.fields.get(f, "") for f in BOM_FIELDS},
+                "DNP": "DNP" if symbol.dnp else "",
+            },
+        )
+        group["refs"].append(reference)
+    rows = []
+    for group in groups.values():
+        refs = sorted(group.pop("refs"), key=_ref_key)
+        rows.append({"Reference": ",".join(refs), "Qty": str(len(refs)), **group})
+    rows.sort(key=lambda row: _ref_key(row["Reference"].split(",")[0]))
+    return rows
+
+
+def write_bom_csv(schematic_path: Path, output: Path) -> Path:
+    rows = bom_rows(schematic_path)
+    output.parent.mkdir(parents=True, exist_ok=True)
+    columns = ["Reference", "Value", "Footprint", "Qty", *BOM_FIELDS, "DNP"]
+    with output.open("w", newline="", encoding="utf-8") as handle:
+        writer = csv.DictWriter(handle, fieldnames=columns)
+        writer.writeheader()
+        for row in rows:
+            writer.writerow({c: row.get(c, "") for c in columns})
+    return output
+
+
+def write_jlc_cpl(board_path: Path, output: Path) -> Path:
+    """Component placement list in the column layout JLCPCB's assembly service accepts."""
+    board = read_board(board_path)
+    output.parent.mkdir(parents=True, exist_ok=True)
+    with output.open("w", newline="", encoding="utf-8") as handle:
+        writer = csv.writer(handle)
+        writer.writerow(["Designator", "Mid X", "Mid Y", "Layer", "Rotation"])
+        for footprint in sorted(board.footprints, key=lambda f: _ref_key(f.reference)):
+            if "exclude_from_pos_files" in footprint.attrs or "board_only" in footprint.attrs:
+                continue
+            if footprint.reference.startswith("#"):
+                continue
+            writer.writerow(
+                [
+                    footprint.reference,
+                    f"{footprint.x:.4f}mm",
+                    f"{-footprint.y:.4f}mm",
+                    jlc_side(footprint.layer),
+                    format_rotation(jlc_rotation(footprint.angle, footprint.layer)),
+                ]
+            )
+    return output