Summary

This project provides an API skill package for AI coding tools, enabling them to interact with EasyEDA Pro. It facilitates AI-driven debugging, code generation, and extension development for the Electronic Design Automation software, benefiting AI developers and EasyEDA users by integrating intelligent assistance directly into the design workflow.

How It Works

The core architecture involves a Node.js WebSocket bridge server acting as an intermediary between AI agents (supporting Agent Skills standard) and the EasyEDA Pro client. AI tools communicate with the bridge via HTTP/WebSocket, sending JavaScript code for execution within EasyEDA. The bridge relays these commands and returns results or errors. Additionally, the project generates structured API documentation and provides specifications for EasyEDA's source file formats, enabling AI to directly analyze or modify project, schematic, and PCB files.

Quick Start & Requirements

• Installation: Run npm install to install Node.js dependencies.
• Build Docs: Execute npm run build:docs to generate structured API documentation from reference files.
• Start Server: Launch the WebSocket bridge with npm run server, which automatically selects an available port between 49620-49629.
• EasyEDA Connection: Install the run-api-gateway.eext extension in EasyEDA Pro, available at https://jlc-ext.com/item/oshwhub/run-api-gateway. The extension automatically connects to the bridge.
• AI Tool Usage: AI coding tools interact via HTTP requests (e.g., curl) to the bridge's /execute endpoint with JavaScript code.
• Prerequisites: Node.js and npm are required.

Highlighted Details

• Provides structured API documentation automatically built from reference docs for fast AI lookup.
• Includes specifications for EasyEDA document source formats (project, schematic, PCB) for direct analysis and modification.
• Features a Node.js WebSocket bridge server to facilitate communication between AI agents and the EasyEDA client.
• Adheres to the Agent Skills standard, with a comprehensive SKILL.md file for AI instruction.

Maintenance & Community

No specific details regarding contributors, sponsorships, or community channels (like Discord/Slack) were found in the provided README snippet.

Licensing & Compatibility

The license type is not specified in the provided README. This absence requires clarification for commercial use or integration into closed-source projects.

Limitations & Caveats

No explicit limitations or known issues are detailed in the provided README. The primary caveat for adoption is the lack of a stated software license.