Quick Start Guide¶

Get started with KiCad-draw in just a few minutes! This guide shows you how to create your first PCB coil with visualization.

Installation¶

pip install kicad-draw

Generating a coil pattern¶

Step 1: Import and Define Parameters¶

from kicad_draw.models import HelixParams
from kicad_draw.PCBmodule import PCBdraw

# Create a simple 2-layer circular coil
params = HelixParams(
    x0=100.0,           # Center X (mm)
    y0=100.0,           # Center Y (mm)  
    radius=10.0,        # Radius (mm)
    port_gap=0.5,       # Port opening (mm)
    tab_gap=0.4,        # Tab extension (mm)
    angle_step=0.0,     # No angular offset
    layer_index_list=[0, 1],  # F.Cu and In1.Cu
    track_width=0.5,    # Track width (mm)
    connect_width=0.2,  # Connection width (mm)
    drill_size=0.2,     # Via drill (mm)
    via_size=0.4,       # Via size (mm)
    net_number=1        # KiCad net number
)

Step 2: Generate the Coil¶

# Create PCB instance
pcb = PCBdraw(stackup="default_4layer", mode="file")

# Draw the coil
pcb.draw_helix(params)

# Generate visualization
svg = pcb.visualize(visible_layers=[0, 1], show_vias=True)

Step 3: Export Your Results¶

# Export KiCad s-expressions
kicad_code = pcb.export()
print("Copy this into your .kicad_pcb file:")
print(kicad_code)

# Save visualization
with open("my_coil.svg", "w") as f:
    f.write(svg)

Common Parameters¶

TBD

Tips¶

Check constraints: Ensure via sizes match your PCB manufacturer’s capabilities
Visualize first: Always check the SVG before importing to KiCad
Test in KiCad: Run DRC after importing to catch any issues