Tom
ce78fb4111
Verified by live test: created a fresh schematic via MCP, result shows
format version 20250114, 0 _TEMPLATE_ hits, 0 (lib_id -100) hits, 24
real components placed cleanly.
--- Format version bump (20230121 KiCAD 7 -> 20250114 KiCAD 9) ---
Files: python/templates/*.kicad_sch, python/commands/project.py,
python/commands/schematic.py
Root cause: the MCP server targets KiCAD 9 exclusively - pcbnew.pyd is
compiled for KiCAD 9.0 / Python 3.11.5, and server.ts explicitly selects
the KiCAD 9 bundled Python on Windows. Generating new schematics with a
2-year-old format tag caused a spurious 'This file was created with an
older KiCAD version' warning on every newly created schematic.
--- Remove corrupt _TEMPLATE_* placed-symbol blocks ---
File: python/templates/template_with_symbols_expanded.kicad_sch
Root cause: the expanded template was generated by the old sexpdata
serializer (same corruption PR #40 fixed for DynamicSymbolLoader add-path).
The serializer converted the string 'Device:R' to integer -100, producing
(lib_id -100) instead of (lib_id Device:R). KiCAD cannot resolve an
integer as a library reference and crashes with a null-pointer when the
user attempts to select these symbols. They appeared as grey _TEMPLATE_R?,
_TEMPLATE_C?, _TEMPLATE_U_REG? etc. ~5000mm off-sheet - invisible during
normal work but triggering a crash on accidental box-select.
Discovered via live testing on a real JLCPCB/KiCAD 9 project.
255 lines
9.5 KiB
Python
255 lines
9.5 KiB
Python
"""
|
|
Project-related command implementations for KiCAD interface
|
|
"""
|
|
|
|
import os
|
|
import pcbnew # type: ignore
|
|
import logging
|
|
import shutil
|
|
from typing import Dict, Any, Optional
|
|
|
|
logger = logging.getLogger("kicad_interface")
|
|
|
|
|
|
class ProjectCommands:
|
|
"""Handles project-related KiCAD operations"""
|
|
|
|
def __init__(self, board: Optional[pcbnew.BOARD] = None):
|
|
"""Initialize with optional board instance"""
|
|
self.board = board
|
|
|
|
def create_project(self, params: Dict[str, Any]) -> Dict[str, Any]:
|
|
"""Create a new KiCAD project"""
|
|
try:
|
|
# Accept both 'name' (from MCP tool) and 'projectName' (legacy)
|
|
project_name = params.get("name") or params.get(
|
|
"projectName", "New_Project"
|
|
)
|
|
path = params.get("path", os.getcwd())
|
|
template = params.get("template")
|
|
|
|
# Generate the full project path
|
|
project_path = os.path.join(path, project_name)
|
|
if not project_path.endswith(".kicad_pro"):
|
|
project_path += ".kicad_pro"
|
|
|
|
# Create project directory if it doesn't exist
|
|
os.makedirs(os.path.dirname(project_path), exist_ok=True)
|
|
|
|
# Create a new board
|
|
board = pcbnew.BOARD()
|
|
|
|
# Set project properties
|
|
board.GetTitleBlock().SetTitle(project_name)
|
|
|
|
# Set current date with proper parameter
|
|
from datetime import datetime
|
|
|
|
current_date = datetime.now().strftime("%Y-%m-%d")
|
|
board.GetTitleBlock().SetDate(current_date)
|
|
|
|
# If template is specified, try to load it
|
|
if template:
|
|
template_path = os.path.expanduser(template)
|
|
if os.path.exists(template_path):
|
|
template_board = pcbnew.LoadBoard(template_path)
|
|
# Copy settings from template
|
|
board.SetDesignSettings(template_board.GetDesignSettings())
|
|
board.SetLayerStack(template_board.GetLayerStack())
|
|
|
|
# Save the board
|
|
board_path = project_path.replace(".kicad_pro", ".kicad_pcb")
|
|
board.SetFileName(board_path)
|
|
pcbnew.SaveBoard(board_path, board)
|
|
|
|
# Create schematic from template (use expanded template with symbol definitions)
|
|
schematic_path = project_path.replace(".kicad_pro", ".kicad_sch")
|
|
template_sch_path = os.path.join(
|
|
os.path.dirname(os.path.abspath(__file__)),
|
|
"..",
|
|
"templates",
|
|
"template_with_symbols_expanded.kicad_sch",
|
|
)
|
|
|
|
if os.path.exists(template_sch_path):
|
|
# Copy template schematic
|
|
shutil.copy(template_sch_path, schematic_path)
|
|
|
|
# Replace placeholder UUID with a real one
|
|
import uuid as uuid_module
|
|
|
|
with open(schematic_path, "r", encoding="utf-8") as f:
|
|
sch_content = f.read()
|
|
sch_content = sch_content.replace(
|
|
"00000000-0000-0000-0000-000000000000", str(uuid_module.uuid4())
|
|
)
|
|
with open(schematic_path, "w", encoding="utf-8") as f:
|
|
f.write(sch_content)
|
|
|
|
logger.info(f"Created schematic from template: {schematic_path}")
|
|
else:
|
|
# Fallback: create minimal schematic
|
|
logger.warning(
|
|
f"Template not found at {template_sch_path}, creating minimal schematic"
|
|
)
|
|
import uuid as uuid_module
|
|
|
|
with open(schematic_path, "w") as f:
|
|
f.write(
|
|
f'(kicad_sch (version 20250114) (generator "KiCAD-MCP-Server")\n\n'
|
|
)
|
|
f.write(f" (uuid {str(uuid_module.uuid4())})\n\n")
|
|
f.write(f' (paper "A4")\n\n')
|
|
f.write(f" (lib_symbols\n )\n\n")
|
|
f.write(f' (sheet_instances\n (path "/" (page "1"))\n )\n')
|
|
f.write(f")\n")
|
|
|
|
# Create project file with schematic reference
|
|
with open(project_path, "w") as f:
|
|
f.write("{\n")
|
|
f.write(' "board": {\n')
|
|
f.write(f' "filename": "{os.path.basename(board_path)}"\n')
|
|
f.write(" },\n")
|
|
f.write(' "sheets": [\n')
|
|
f.write(f' ["root", "{os.path.basename(schematic_path)}"]\n')
|
|
f.write(" ]\n")
|
|
f.write("}\n")
|
|
|
|
self.board = board
|
|
|
|
return {
|
|
"success": True,
|
|
"message": f"Created project: {project_name}",
|
|
"project": {
|
|
"name": project_name,
|
|
"path": project_path,
|
|
"boardPath": board_path,
|
|
"schematicPath": schematic_path,
|
|
},
|
|
}
|
|
|
|
except Exception as e:
|
|
logger.error(f"Error creating project: {str(e)}")
|
|
return {
|
|
"success": False,
|
|
"message": "Failed to create project",
|
|
"errorDetails": str(e),
|
|
}
|
|
|
|
def open_project(self, params: Dict[str, Any]) -> Dict[str, Any]:
|
|
"""Open an existing KiCAD project"""
|
|
try:
|
|
filename = params.get("filename")
|
|
if not filename:
|
|
return {
|
|
"success": False,
|
|
"message": "No filename provided",
|
|
"errorDetails": "The filename parameter is required",
|
|
}
|
|
|
|
# Expand user path and make absolute
|
|
filename = os.path.abspath(os.path.expanduser(filename))
|
|
|
|
# If it's a project file, get the board file
|
|
if filename.endswith(".kicad_pro"):
|
|
board_path = filename.replace(".kicad_pro", ".kicad_pcb")
|
|
else:
|
|
board_path = filename
|
|
|
|
# Load the board
|
|
board = pcbnew.LoadBoard(board_path)
|
|
self.board = board
|
|
|
|
return {
|
|
"success": True,
|
|
"message": f"Opened project: {os.path.basename(board_path)}",
|
|
"project": {
|
|
"name": os.path.splitext(os.path.basename(board_path))[0],
|
|
"path": filename,
|
|
"boardPath": board_path,
|
|
},
|
|
}
|
|
|
|
except Exception as e:
|
|
logger.error(f"Error opening project: {str(e)}")
|
|
return {
|
|
"success": False,
|
|
"message": "Failed to open project",
|
|
"errorDetails": str(e),
|
|
}
|
|
|
|
def save_project(self, params: Dict[str, Any]) -> Dict[str, Any]:
|
|
"""Save the current KiCAD project"""
|
|
try:
|
|
if not self.board:
|
|
return {
|
|
"success": False,
|
|
"message": "No board is loaded",
|
|
"errorDetails": "Load or create a board first",
|
|
}
|
|
|
|
filename = params.get("filename")
|
|
if filename:
|
|
# Save to new location
|
|
filename = os.path.abspath(os.path.expanduser(filename))
|
|
self.board.SetFileName(filename)
|
|
|
|
# Save the board
|
|
pcbnew.SaveBoard(self.board.GetFileName(), self.board)
|
|
|
|
return {
|
|
"success": True,
|
|
"message": f"Saved project to: {self.board.GetFileName()}",
|
|
"project": {
|
|
"name": os.path.splitext(
|
|
os.path.basename(self.board.GetFileName())
|
|
)[0],
|
|
"path": self.board.GetFileName(),
|
|
},
|
|
}
|
|
|
|
except Exception as e:
|
|
logger.error(f"Error saving project: {str(e)}")
|
|
return {
|
|
"success": False,
|
|
"message": "Failed to save project",
|
|
"errorDetails": str(e),
|
|
}
|
|
|
|
def get_project_info(self, params: Dict[str, Any]) -> Dict[str, Any]:
|
|
"""Get information about the current project"""
|
|
try:
|
|
if not self.board:
|
|
return {
|
|
"success": False,
|
|
"message": "No board is loaded",
|
|
"errorDetails": "Load or create a board first",
|
|
}
|
|
|
|
title_block = self.board.GetTitleBlock()
|
|
filename = self.board.GetFileName()
|
|
|
|
return {
|
|
"success": True,
|
|
"project": {
|
|
"name": os.path.splitext(os.path.basename(filename))[0],
|
|
"path": filename,
|
|
"title": title_block.GetTitle(),
|
|
"date": title_block.GetDate(),
|
|
"revision": title_block.GetRevision(),
|
|
"company": title_block.GetCompany(),
|
|
"comment1": title_block.GetComment(0),
|
|
"comment2": title_block.GetComment(1),
|
|
"comment3": title_block.GetComment(2),
|
|
"comment4": title_block.GetComment(3),
|
|
},
|
|
}
|
|
|
|
except Exception as e:
|
|
logger.error(f"Error getting project info: {str(e)}")
|
|
return {
|
|
"success": False,
|
|
"message": "Failed to get project information",
|
|
"errorDetails": str(e),
|
|
}
|