KiCad Tools

Create an unfilled copper zone: a ground plane, power plane, or any filled copper pour. Call fill_zones afterward to compute the fills. Args: net_name: Name of the net to assign to this zone (e.g. "GND") layer: Copper layer (e.g. "F.Cu", "B.Cu") corners: List of {x, y} dicts defining the zone polygon (min 3) clearance: Zone clearance in mm min_thickness: Minimum copper thickness in mm thermal_relief: Use thermal relief pads (True) or solid connection (False) thermal_gap: Thermal relief gap in mm thermal_bridge_width: Thermal relief bridge width in mm priority: Zone fill priority (higher fills first) pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default.

Add a global net label (visible across all sheets). Args: text: Net name (e.g. "VCC", "SDA") x: X position y: Y position rotation: Degrees (0=right, 90=up, 180=left, 270=down) shape: Label shape: input, output, bidirectional, tri_state, passive schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default.

Add a hierarchical label to a sub-sheet schematic. Args: text: Label name (must match parent sheet pin name) shape: Direction — input, output, bidirectional, tri_state, passive x: X position in mm y: Y position in mm rotation: Degrees (0, 90, 180, 270) schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default.

Add a hierarchical sheet to a parent schematic with matching labels in the child. Creates the sheet block in the parent and corresponding hierarchical labels in the child schematic. The child schematic must already exist (create it with create_schematic first). Args: parent_schematic_path: Path to parent .kicad_sch sheet_name: Display name for the sheet sheet_file: Path to child .kicad_sch (must exist) pins: List of dicts with 'name' (str) and 'direction' (str) keys. Direction: input, output, bidirectional, tri_state, passive. x: X position of sheet block (default 25.4) y: Y position of sheet block (default 25.4) project_path: Path to .kicad_pro file (for sub-sheet instance tracking)

Add multiple junctions. Each point dict has keys: x, y. Args: points: List of junction positions [{x, y}, ...] schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default.

Create a keep-out zone that restricts placement of specified items. Args: corners: List of {x, y} dicts defining the zone polygon (min 3) layers: Layers to apply keep-out to (default: ["F.Cu", "B.Cu"]) no_tracks: Restrict tracks in this zone no_vias: Restrict vias in this zone no_pads: Restrict pads in this zone no_copper_pour: Restrict copper pour in this zone no_footprints: Restrict footprints in this zone pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default.

Add a net label at a position. Args: text: Net name (e.g. "VIN_PROT", "5V_REL") x: X position y: Y position rotation: Degrees (0=right, 90=up, 180=left, 270=down) schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default.

Load a symbol definition from a .kicad_sym library into the schematic. Args: symbol_lib_path: Path to .kicad_sym file. Optional; omit to use the configured default. symbol_name: Symbol name (e.g. "LM7805") schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default.

Add a graphic line to the PCB (edge cuts, silkscreen, etc.). Args: x1: Start X y1: Start Y x2: End X y2: End Y layer: Layer (e.g. "Edge.Cuts", "F.SilkS") width: Line width in mm pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default.

Add text to the PCB (silkscreen, fab layer, etc.). Args: text: Text content x: X position y: Y position layer: Layer (e.g. "F.SilkS", "B.SilkS", "F.Fab") rotation: Rotation in degrees pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default.

Place a power symbol (VCC, GND, +3V3, etc.). Uses place_component internally. Power symbols are regular symbols from the 'power' library with isPower=True. Places only the symbol asked for. A PWR_FLAG tells ERC the net has a source it cannot see, which only the designer knows, so add one with lib_id="power:PWR_FLAG" on each net that needs it. Args: lib_id: Library ID (e.g. "power:VCC", "power:GND") reference: Reference (e.g. "#PWR01") x: X position y: Y position rotation: Rotation in degrees symbol_lib_path: Path to a .kicad_sym file that defines the power symbol, for a library outside KiCad's stock set. Optional; omit to load it from the stock library named by the lib_id prefix. schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default. project_path: Path to .kicad_pro file (for sub-sheet instance tracking)

Add a pin to an existing hierarchical sheet block. Args: sheet_uuid: UUID of the sheet pin_name: Pin name (should match a hierarchical label in the child schematic) connection_type: input, output, bidirectional, tri_state, passive schematic_path: Path to parent .kicad_sch. Optional; omit to use the configured default. side: Which sheet edge to place pin on (left or right)

Add a new symbol definition to a .kicad_sym library. Creates a complete symbol with pins and body graphics. If the library file does not exist it will be created. Args: name: Symbol name (e.g. "MP4572GQB-P", "TLV75733PDBVR") pins: Pin definitions — list of dicts, each with keys: number (str): pin number, e.g. "1" name (str): pin name, e.g. "VIN" ("~" for unnamed) type (str): electrical type — "input", "output", "bidirectional", "passive", "power_in", "power_out", "tri_state", "open_collector", "open_emitter", "unconnected", "free" x (float): X position in mm (default 0) y (float): Y position in mm (default 0) rotation (float): angle 0/90/180/270 (default 0) length (float): pin length in mm (default 2.54) reference_prefix: Reference prefix e.g. "U", "R", "C" (default "U") is_power: True for power symbols (default False) pin_names_offset: Pin name label offset in mm (default 0.508) in_bom: Include in BOM (default True) on_board: Place on board (default True) footprint: Default footprint e.g. "Package_SO:SOIC-8" (default "") datasheet: Datasheet URL (default "~") rectangles: Optional body rectangle(s) — list of dicts with keys: x1, y1, x2, y2 (float): corner coordinates in mm fill (str): "none", "background", or "outline" (default "background") If omitted, a rectangle is auto-computed from pin positions. symbol_lib_path: Path to .kicad_sym file. Optional; omit to use the configured default.

Add a text annotation to the schematic. Args: text: Text content x: X position y: Y position rotation: Rotation in degrees schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default.

Add a grid of thermal vias under a footprint pad. Args: reference: Footprint reference (e.g. "U1", "R1") pad_number: Pad number to center vias on. If empty, auto-selects largest SMD pad. rows: Number of rows in the via grid, at least 1. rows * cols is at most 256. cols: Number of columns in the via grid, at least 1. spacing: Spacing between vias in mm via_size: Via annular ring diameter in mm via_drill: Via drill diameter in mm net_name: Net to assign to vias. If None, auto-detect from pad. pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default.

Add a trace segment between two points. Args: x1: Start X y1: Start Y x2: End X y2: End Y width: Trace width in mm layer: Copper layer (e.g. "F.Cu", "B.Cu") net: Net number. 0 means no net, which a KiCad 10 board writes as (net "") (pcb_io_kicad_sexpr.cpp:2860-2861 at 10.0.7). pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default.

Add a via at a position. Args: x: X position y: Y position size: Via pad size in mm drill: Drill diameter in mm net: Net number. 0 means no net, which a KiCad 10 board writes as (net "") (pcb_io_kicad_sexpr.cpp:2860-2861 at 10.0.7). layers: Via layers (default: ["F.Cu", "B.Cu"]) pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default.

Add multiple wires at once. Each wire dict has keys: x1, y1, x2, y2. Args: wires: List of wire defs [{x1, y1, x2, y2}, ...] schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default.

Auto-assign reference designators to unannotated components. Finds components with '?' in their reference (e.g. R?, U?) and assigns sequential numbers, respecting existing references in the schematic and across the hierarchy when project_path is provided. Args: schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default. project_path: Path to .kicad_pro file (scans hierarchy for existing refs)

Place a decoupling capacitor and wire it to power/ground nets. Places the cap, wires pin 1 (top) to power_net and pin 2 (bottom) to ground_net via stub wires + labels. Args: lib_id: Cap symbol (e.g. "Device:C") reference: Reference (e.g. "C5") value: Cap value (e.g. "100nF") x: X position y: Y position power_net: Label for pin 1 (e.g. "VCC", "+3V3") ground_net: Label for pin 2 (e.g. "GND", "PGND") rotation: Rotation in degrees (default 0) symbol_lib_path: Path to a .kicad_sym file that defines the capacitor, for a library outside KiCad's stock set. Optional; omit to load it from the stock library named by the lib_id prefix. schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default. project_path: Path to .kicad_pro file (for sub-sheet instance tracking)

Autoroute PCB traces using the Freerouting autorouter. Exports the board to Specctra DSN format, runs Freerouting for automated trace routing, and imports the results into a new PCB file. The original board is never modified. Requires Java 17+ and KiCad's pcbnew Python bindings, whose major version has to match the board's format era. On first run, the Freerouting JAR is auto-downloaded (~20MB). Args: pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default. max_passes: Maximum autorouter optimization passes num_threads: Thread count for routing. Defaults to 1 because freerouting prints "Multi-threaded route optimization is broken and it is known to generate clearance violations" on every run. Raise it only if you are willing to DRC the result carefully. timeout: Max seconds to wait for routing (default: 600) output_dir: Directory for output files (default: same as PCB). Optional; omit to use the configured default.

Check if placing/moving a footprint to (x, y) would violate constraints. Both checks are on the footprint's origin point, not its courtyard, so a footprint whose body overlaps a keep-out while its origin does not still reports ok. That is also why there is no rotation parameter: rotating about the origin cannot move the origin, so an angle could not change either answer. Keep-outs are read as KiCad reads them: a footprint's own keep-outs in board coordinates, as the file stores them; a layer set such as *.Cu or F&B.Cu as the layers it names; the footprint on its side, B.Cu or else F.Cu, as KiCad reads any other footprint layer; and the footprint's own keep-outs never count against it (intersectsArea skips an area whose parent is the item, pcbnew/pcbexpr_functions.cpp:697 at 9.0.8). Args: reference: Footprint reference designator x: Proposed X position y: Proposed Y position pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default.

Connect two component pins with Manhattan (L-shaped) wire routing. Combines get_pin_positions + coordinate math + add_wires into one call. Args: ref1: First component reference (e.g. "U1") pin1: First pin name or number ref2: Second component reference (e.g. "C3") pin2: Second pin name or number schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default.

Create a KiCad 9 project (.kicad_pro + .kicad_prl + .kicad_sch). Args: directory: Directory to create the project in (created if missing) name: Project name (used for filenames)

Create a valid empty KiCad 9 schematic file. Args: schematic_path: Path for the new .kicad_sch file. Optional; omit to use the configured default.

Create a sym-lib-table file in the given directory. Each entry dict needs 'name' and 'uri' keys. Overwrites existing sym-lib-table if present. Args: directory: Directory to write sym-lib-table in entries: List of dicts with 'name' and 'uri' keys

Create a valid empty KiCad 9 symbol library. Args: symbol_lib_path: Path for the new .kicad_sym file. Optional; omit to use the configured default.

Duplicate a hierarchical sheet, copying the child file with new UUIDs. Args: sheet_uuid: UUID of the sheet to duplicate new_sheet_name: Display name for the new sheet schematic_path: Path to parent .kicad_sch. Optional; omit to use the configured default. project_path: Path to .kicad_pro (for hierarchy metadata) new_file_name: Name for the copied file (auto-generated if empty)

Export PCB 3D model or render 3D view to image. `render` fills width, height and side; the mesh formats leave them unset. Args: format: Output format - "step", "stl", "glb", or "render" (PNG image) pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default. output_dir: Output directory. Optional; omit to use the configured default. width: Image width in pixels (render only) height: Image height in pixels (render only) side: View side: top, bottom, left, right, front, back (render only) quality: Render quality: basic, high (render only)

Export Bill of Materials (BOM) as CSV. Args: schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default. output_dir: Output directory. Optional; omit to use the configured default.

Export footprint to SVG. Args: footprint_path: Path to a .kicad_mod file, or a .pretty library directory. Optional; omit to use the configured default. output_dir: Output directory. Optional; omit to use the configured default.

Export Gerber files for manufacturing. When layers contains exactly one layer, exports a single Gerber file: path names it, and size_bytes and layer are filled. Otherwise exports all layers (or the specified subset) plus optional drill files, and path names the output directory. files and count are filled either way. Args: pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default. output_dir: Output directory for gerber files. Optional; omit to use the configured default. include_drill: Also export drill files (default: True, ignored in single-layer mode) layers: Optional list of layer names. Single layer = single file output.

Export a netlist from the root schematic, including hierarchy info. Runs kicad-cli to generate a netlist and returns parsed component/net data with sheet path information for each component. Args: schematic_path: Path to root .kicad_sch file. Optional; omit to use the configured default. output_dir: Directory for netlist output (defaults to schematic directory). Optional; omit to use the configured default.

Export PCB in IPC-2581 format for manufacturing data exchange. Args: pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default. output: Output file path precision: Numeric precision (default: 3) compress: Compress output file version: IPC-2581 version (default: "C") units: Output units - "mm" or "in"

Export a schematic netlist. Args: schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default. output_dir: Output directory. Optional; omit to use the configured default. format: Netlist format. spice and spicemodel produce simulator input.

Export PCB to PDF, SVG, or DXF format. Args: format: Output format - "pdf", "svg", or "dxf" pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default. output_dir: Directory for output files. Optional; omit to use the configured default. layers: Optional list of layer names to include (required for DXF) output_units: DXF output units - "in" or "mm" (DXF only) exclude_refdes: Exclude reference designators (DXF only) exclude_value: Exclude component values (DXF only) use_contours: Use board outline contours (DXF only) include_border_title: Include border and title block (DXF only)

Export component position file (pick and place). Args: pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default. output_dir: Output directory. Optional; omit to use the configured default.

Export schematic to PDF, SVG, or DXF format. pdf and dxf produce one file, so path names it and size_bytes is filled. svg produces one file per sheet, so path names the directory. files and count are filled either way. Args: format: Output format - "pdf", "svg", or "dxf" schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default. output_dir: Directory for output files. Optional; omit to use the configured default.

Export symbol library to SVG images. Args: symbol_lib_path: Path to .kicad_sym file. Optional; omit to use the configured default. output_dir: Output directory. Optional; omit to use the configured default.

Fill all copper zones on the board using pcbnew's zone filler. pcbnew computes the fill; this server writes it. The board is handed to pcbnew read-only and the computed polygons come back as data, so the file that reaches the disk is the original with its zones' fills replaced and every other byte untouched. Nothing else about it changes: not its format version, not its layer names, not the constructs pcbnew does not model. Requires KiCad's pcbnew Python bindings to be installed. Args: pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default.

Flatten a hierarchical schematic into a single sheet. Merges all child sheet content into one schematic with offset positions. Creates a new file — does NOT modify the original hierarchy. Args: schematic_path: Path to root .kicad_sch file. Optional; omit to use the configured default. output_path: Path for flattened output (defaults to *_flat.kicad_sch)

Get board summary: footprint count, trace count, net count, thickness. Args: pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default.

Get the board-coordinate bounding box of a placed footprint. Args: reference: Footprint reference designator pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default.

Get pad and outline details for a footprint .kicad_mod file. Args: footprint_path: Path to .kicad_mod file. Optional; omit to use the configured default.

Get pad info for a placed footprint on the PCB. Args: reference: Footprint reference (e.g. "R1", "U1") pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default.

Find all component pins connected to a net label. Scans labels matching the text, traces wires from label positions, and identifies component pins at wire endpoints. Each placed symbol contributes only its own unit's pins, so a multi-unit part does not report a sibling gate's input as sitting on this net. Args: label_text: Net name to search for (e.g. "VCC", "GND") schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default.

Get absolute pin positions for a placed component (accounts for rotation/mirror). A multi-unit part is placed as one symbol per unit and they all share the reference, so every placed unit is listed, each with its own pins plus the unit-0 pins they all share. Args: reference: Component reference (e.g. "U1", "R1") schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default.

Get schematic page info and item counts. Args: schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default.

Get detailed info about a hierarchical sheet including pin/label matching. Args: sheet_uuid: UUID of the sheet schematic_path: Path to parent .kicad_sch. Optional; omit to use the configured default.

Get detailed pin and property info for a symbol in a library. Args: symbol_name: Symbol name (e.g. "LM7805") symbol_lib_path: Path to .kicad_sym file. Optional; omit to use the configured default.