Upload kicad_writer.py with huggingface_hub

kicad_writer.py

@@ -0,0 +1,315 @@
+import json
+import uuid
+import sys
+import os
+from datetime import datetime
+
+# ─────────────────────────────────────────────
+#  CONFIGURATION
+# ─────────────────────────────────────────────
+KICAD_VERSION  = 20231120
+GRID_SIZE      = 100      # mils — schematic grid spacing
+START_X        = 50       # starting X position for first component
+START_Y        = 50       # starting Y position for first component
+COLS           = 8        # components per row before wrapping
+
+# KiCAD symbol mapping per component type
+# Format: (library, symbol_name, pin_count)
+SYMBOL_MAP = {
+    "resistor":               ("Device", "R",          2),
+    "resistor jumper":        ("Device", "R",          2),
+    "capacitor":              ("Device", "C",          2),
+    "capacitor jumper":       ("Device", "C",          2),
+    "electrolytic capacitor": ("Device", "CP",         2),
+    "inductor":               ("Device", "L",          2),
+    "diode":                  ("Device", "D",          2),
+    "led":                    ("Device", "LED",        2),
+    "transistor":             ("Device", "Q_NPN_BCE",  3),
+    "ic":                     ("Device", "IC",         4),
+    "connector":              ("Connector", "Conn_01x04", 4),
+    "jumper":                 ("Device", "Jumper",     2),
+    "button":                 ("Device", "SW_Push",    2),
+    "clock":                  ("Device", "Crystal",    2),
+    "transformer":            ("Device", "Transformer_1P_1S", 4),
+    "potentiometer":          ("Device", "R_POT",      3),
+    "fuse":                   ("Device", "Fuse",       2),
+    "ferrite_bead":           ("Device", "Ferrite_Bead", 2),
+    "buzzer":                 ("Device", "Buzzer",     2),
+    "display":                ("Device", "LED_7Seg",   4),
+    "battery":                ("Device", "Battery",    2),
+    "emi_filter":             ("Device", "L",          2),
+    "resistor network":       ("Device", "R_Pack04",   8),
+    "pins":                   ("Connector", "TestPoint", 1),
+}
+
+DEFAULT_SYMBOL = ("Device", "R", 2)
+
+
+# ─────────────────────────────────────────────
+#  UUID GENERATOR
+# ─────────────────────────────────────────────
+def new_uuid() -> str:
+    return str(uuid.uuid4())
+
+
+# ─────────────────────────────────────────────
+#  POSITION CALCULATOR
+#  Arranges components in a grid layout
+# ─────────────────────────────────────────────
+def calculate_positions(components: list) -> list:
+    positioned = []
+    for i, comp in enumerate(components):
+        col = i % COLS
+        row = i // COLS
+        x   = START_X + col * GRID_SIZE * 2
+        y   = START_Y + row * GRID_SIZE * 3
+        positioned.append({**comp, "sch_x": x, "sch_y": y})
+    return positioned
+
+
+# ─────────────────────────────────────────────
+#  BUILD lib_symbols SECTION
+#  Defines all unique symbols used in schematic
+# ─────────────────────────────────────────────
+def build_lib_symbols(components: list) -> list:
+    lines = []
+    lines.append("  (lib_symbols")
+
+    seen = set()
+    for comp in components:
+        label      = comp['label'].lower()
+        lib, sym, pins = SYMBOL_MAP.get(label, DEFAULT_SYMBOL)
+        key        = f"{lib}:{sym}"
+        if key in seen:
+            continue
+        seen.add(key)
+
+        lines.append(f"    (symbol \"{lib}:{sym}\"")
+        lines.append(f"      (pin_numbers (hide yes))")
+        lines.append(f"      (pin_names (offset 1.016) (hide yes))")
+        lines.append(f"      (in_bom yes) (on_board yes)")
+
+        # Simple box symbol body
+        lines.append(f"      (symbol \"{lib}:{sym}_0_1\"")
+        lines.append(f"        (rectangle (start -1.016 -2.032) (end 1.016 2.032)")
+        lines.append(f"          (stroke (width 0) (type default))")
+        lines.append(f"          (fill (type none))")
+        lines.append(f"        )")
+        lines.append(f"      )")
+
+        # Pins
+        lines.append(f"      (symbol \"{lib}:{sym}_1_1\"")
+        for p in range(1, pins + 1):
+            py = 2.032 - (p - 1) * (4.064 / max(pins - 1, 1)) if pins > 1 else 0
+            lines.append(f"        (pin unspecified line")
+            lines.append(f"          (at -3.81 {py:.3f} 0)")
+            lines.append(f"          (length 2.794)")
+            lines.append(f"          (name \"{p}\" (effects (font (size 1.27 1.27))))")
+            lines.append(f"          (number \"{p}\" (effects (font (size 1.27 1.27))))")
+            lines.append(f"        )")
+        lines.append(f"      )")
+        lines.append(f"    )")
+
+    lines.append("  )")
+    return lines
+
+
+# ─────────────────────────────────────────────
+#  BUILD SYMBOL INSTANCES
+#  Places each component on the schematic
+# ─────────────────────────────────────────────
+def build_symbol_instances(components: list) -> list:
+    lines = []
+
+    for comp in components:
+        label       = comp['label'].lower()
+        refdes      = comp['refdes']
+        part        = comp.get('part_number', label)
+        x           = comp['sch_x']
+        y           = comp['sch_y']
+        comp_uuid   = new_uuid()
+        lib, sym, _ = SYMBOL_MAP.get(label, DEFAULT_SYMBOL)
+
+        lines.append(f"  (symbol")
+        lines.append(f"    (lib_id \"{lib}:{sym}\")")
+        lines.append(f"    (at {x} {y} 0)")
+        lines.append(f"    (unit 1)")
+        lines.append(f"    (in_bom yes) (on_board yes)")
+        lines.append(f"    (uuid \"{comp_uuid}\")")
+
+        # Reference field
+        lines.append(f"    (property \"Reference\" \"{refdes}\"")
+        lines.append(f"      (at {x} {y - 3.81} 0)")
+        lines.append(f"      (effects (font (size 1.27 1.27)))")
+        lines.append(f"    )")
+
+        # Value field
+        lines.append(f"    (property \"Value\" \"{part}\"")
+        lines.append(f"      (at {x} {y + 3.81} 0)")
+        lines.append(f"      (effects (font (size 1.27 1.27)))")
+        lines.append(f"    )")
+
+        # Footprint field (empty for now)
+        lines.append(f"    (property \"Footprint\" \"\"")
+        lines.append(f"      (at {x} {y} 0)")
+        lines.append(f"      (effects (font (size 1.27 1.27)) (hide yes))")
+        lines.append(f"    )")
+
+        lines.append(f"  )")
+
+    return lines
+
+
+# ─────────────────────────────────────────────
+#  BUILD NET LABELS
+#  Places net labels connecting components
+# ─────────────────────────────────────────────
+def build_net_labels(components: list, nets: dict) -> list:
+    lines      = []
+    refdes_map = {c['refdes']: c for c in components}
+
+    for net_name, members in nets.items():
+        for refdes in members:
+            comp = refdes_map.get(refdes)
+            if not comp:
+                continue
+
+            x = comp['sch_x'] - 3.81
+            y = comp['sch_y']
+
+            lines.append(f"  (label \"{net_name}\"")
+            lines.append(f"    (at {x} {y} 0)")
+            lines.append(f"    (effects (font (size 1.27 1.27)) (justify left))")
+            lines.append(f"    (uuid \"{new_uuid()}\")")
+            lines.append(f"  )")
+
+    return lines
+
+
+# ─────────────────────────────────────────────
+#  BUILD WIRES
+#  Draws wires between components in same net
+# ─────────────────────────────────────────────
+def build_wires(components: list, nets: dict) -> list:
+    lines      = []
+    refdes_map = {c['refdes']: c for c in components}
+
+    for net_name, members in nets.items():
+        if len(members) < 2:
+            continue
+
+        # Connect each member to the next one with a wire
+        for i in range(len(members) - 1):
+            a = refdes_map.get(members[i])
+            b = refdes_map.get(members[i + 1])
+            if not a or not b:
+                continue
+
+            x1, y1 = a['sch_x'], a['sch_y']
+            x2, y2 = b['sch_x'], b['sch_y']
+
+            lines.append(f"  (wire")
+            lines.append(f"    (pts (xy {x1} {y1}) (xy {x2} {y2}))")
+            lines.append(f"    (stroke (width 0) (type default))")
+            lines.append(f"    (uuid \"{new_uuid()}\")")
+            lines.append(f"  )")
+
+    return lines
+
+
+# ─────────────────────────────────────────────
+#  MAIN — GENERATE .kicad_sch FILE
+# ─────────────────────────────────────────────
+def generate_kicad_schematic(netlist_json_path: str,
+                              output_path: str = None) -> str:
+    print(f"\n{'='*50}")
+    print(f"  KiCAD Schematic Writer")
+    print(f"  Input: {netlist_json_path}")
+    print(f"{'='*50}\n")
+
+    # Load netlist JSON
+    with open(netlist_json_path) as f:
+        data = json.load(f)
+
+    components = data.get("components", [])
+    nets       = data.get("nets", {})
+
+    for c in components:
+        c['bbox'] = tuple(c['bbox'])
+
+    print(f"[OK] Loaded {len(components)} components, {len(nets)} nets")
+
+    # Calculate grid positions
+    components = calculate_positions(components)
+
+    # Build schematic sections
+    lib_symbols = build_lib_symbols(components)
+    instances   = build_symbol_instances(components)
+    net_labels  = build_net_labels(components, nets)
+    wires       = build_wires(components, nets)
+
+    # Assemble full .kicad_sch file
+    timestamp   = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
+    sheet_uuid  = new_uuid()
+
+    lines = []
+    lines.append(f"(kicad_sch (version {KICAD_VERSION}) (generator \"PCB_Image2Schematic\")")
+    lines.append(f"")
+    lines.append(f"  (uuid \"{sheet_uuid}\")")
+    lines.append(f"")
+    lines.append(f"  (paper \"A3\")")
+    lines.append(f"")
+    lines.append(f"  (title_block")
+    lines.append(f"    (title \"PCB Image to Schematic\")")
+    lines.append(f"    (date \"{timestamp}\")")
+    lines.append(f"    (rev \"1.0\")")
+    lines.append(f"    (comment 1 \"Auto-generated by PCB Image2Schematic\")")
+    lines.append(f"    (comment 2 \"Source: {netlist_json_path}\")")
+    lines.append(f"  )")
+    lines.append(f"")
+
+    # lib_symbols
+    lines.extend(lib_symbols)
+    lines.append("")
+
+    # component instances
+    lines.extend(instances)
+    lines.append("")
+
+    # net labels
+    lines.extend(net_labels)
+    lines.append("")
+
+    # wires
+    lines.extend(wires)
+    lines.append("")
+
+    lines.append(")")
+
+    # Write file
+    if output_path is None:
+        base        = os.path.splitext(netlist_json_path)[0]
+        output_path = base.replace("_netlist", "") + ".kicad_sch"
+
+    with open(output_path, "w") as f:
+        f.write("\n".join(lines))
+
+    print(f"[OK] KiCAD schematic saved: {output_path}")
+    print(f"     Components placed  : {len(components)}")
+    print(f"     Nets wired         : {len(nets)}")
+    print(f"     Net labels added   : {len(net_labels) // 5}")
+    print(f"\n     Open in KiCAD: File > Open Schematic > {output_path}")
+
+    return output_path
+
+
+# ─────────────────────────────────────────────
+#  ENTRY POINT
+# ─────────────────────────────────────────────
+if __name__ == "__main__":
+    if len(sys.argv) < 2:
+        print("Usage: python kicad_writer.py <netlist_json>")
+        print("Example: python kicad_writer.py 'sample 5_netlist.json'")
+        sys.exit(1)
+
+    generate_kicad_schematic(sys.argv[1])