Check connection to KiCad and return version info.

Check if the connected KiCad version matches the kipy library version.

Get high-level information about the currently open board.

Get the board title block info.

Update title block information for the board.

All parameters are optional. Values not specified will remain unchanged.

Get stackup layers, thickness, material, and electrical properties.

Get raw design rules (KiCad 11+).

Get custom design rules text and any parsing errors (KiCad 11+).

Set custom design rules text (KiCad 11+).

Get list of currently enabled board layers.

Get list of visible board layers.

Set the list of visible board layers.

Get current active board layer name.

Set the active board layer.

Get board origin coordinates (grid or drill).

Set board origin coordinates (grid or drill).

Retrieve the entire board (.kicad_pcb) content as text.

Save the board changes to file.

Save the board as a new file.

Revert board to the last saved state on disk.

Begin an edit transaction for batching multiple operations into a single Undo step.

Push/apply the active transaction and close the commit.

Drop/cancel the active transaction and discard changes.

List footprints on the board, optionally filtered by reference designator substring.

Retrieve detailed information about a specific footprint by its reference designator.

Get the bounding box of a footprint (in millimeters).

Move a footprint to absolute coordinates (in millimeters).

Rotate a footprint to a specific absolute angle (in degrees).

Move and rotate a footprint in one operation.

Flip a footprint to the opposite side of the board (F.Cu <=> B.Cu).

Lock or unlock a footprint to prevent accidental movement.

Set the Do Not Populate (DNP) flag on a footprint.

Set whether a footprint is excluded from the Bill of Materials (BOM).

Update or add a field on a footprint (e.g. Reference, Value, custom fields).

Remove a footprint from the board.

List all pads of a footprint.

Get detailed information for a single pad of a footprint.

Retrieve items connected to a specific pad.

Initiates an interactive move in the GUI. Returns immediately but blocks further API calls until complete.

List tracks on the board, optionally filtered by net name and/or layer name.

Get details of a specific track by its ID.

Add a straight track segment to the board.

Add an arc track segment to the board.

Update the width of a track segment.

Update the net assigned to a track.

Move a track by a relative delta (in millimeters).

Lock or unlock a track segment.

Remove a track segment from the board.

Remove all tracks within a bounding box, optionally filtered by layer name.

List tracks belonging to a specific net.

List tracks belonging to all nets in a net class.

List vias on the board, optionally filtered by net name.

Get details of a specific via by its ID.

Add a via to the board.

Update the diameter and/or drill size of a via.

Update the net assigned to a via.

Lock or unlock a via.

Remove a via from the board.

List zones on the board, optionally filtered by net and/or layer.

Get details of a specific zone by its ID.

Add a rectangular copper pour zone to the board.

Add a polygonal copper pour zone to the board.

points_mm should be a list of dicts like [{"x_mm": 0, "y_mm": 0}, ...]

Add a keep-out / rule area zone (non-copper) to the board.

Change the net assigned to a copper zone.

Change the priority level of a zone.

Update the clearance setting of a copper zone.

Shift a zone by a relative delta (in millimeters).

Lock or unlock a zone.

Remove a zone from the board.

Trigger refilling of all zones on the board.

List nets on the board, optionally filtered by netclass name.

Retrieve all board items associated with a specific net.

Retrieve all board items associated with nets in a specific netclass.

Retrieve netclass settings for a given net.

Import a netlist file into the board. (Requires newer KiCad/kipy API).

List free text and text box items on the board, optionally filtered by layer name.

Get details of a specific text or text box item by its ID.

Add a free text object to the board.

Add a text box to the board.

Update the text value of a text or text box item.

Update the position of a text item (top-left for text boxes).

Update the layer of a text or text box item.

Update text formatting attributes.

Lock or unlock a text or text box item.

Remove a text or text box item from the board.

Expand text variables in the given string based on board/project settings.

List graphic shapes on the board, optionally filtered by layer name.

Get details of a specific graphic shape by its ID.

Add a straight graphic segment (line) to the board.

Add a graphic rectangle to the board.

Add a graphic circle to the board.

Add a graphic arc to the board.

Add a graphic polygon to the board.

points_mm should be a list like [{"x_mm": 0, "y_mm": 0}, ...]

Move a shape by a relative offset (in millimeters).

Rotate a shape by an angle around a center point (in degrees).

Change the layer of a shape.

Update the stroke line width of a shape.

Lock or unlock a shape.

Remove a shape from the board.

List dimension annotations on the board, optionally filtered by layer name.