EasyEDA API Skill

🔌 嘉立创EDA Pro 官方编程接口

为嘉立创EDA Pro(EasyEDA Pro)提供完整API编程接口,支持120+类/62枚举/70接口,通过WebSocket桥接实现实时调试与扩展开发

收藏
26.6k
安装
6.2k
版本
1.0.8
CLS 安全性认证2026-08-04
点击查看完整报告 >

使用说明

功能概述

easyeda-api 是嘉立创EDA专业版(EasyEDA Pro)的官方编程接口工具,专为AI代理和自动化工作流设计,使开发者能够通过代码直接控制PCB设计、原理图编辑、封装管理、项目操作等核心功能。

核心能力

1. 完整API覆盖
提供120+类、62个枚举、70个接口、19个类型别名的完整TypeScript文档,涵盖:

  • DMT_*:项目/文档管理(Project、Board、Schematic、EditorControl等)
  • PCB_*:PCB与封装设计(Primitive、Layer、Net、Drc等)
  • SCH_*:原理图设计(Component、Wire、Event等)
  • LIB_*:库管理(Device、Footprint、Symbol、3DModel等)
  • SYS_*:系统功能(Dialog、FileSystem、MessageBus、IFrame等)

2. WebSocket实时桥接
通过Node.js桥接服务器(端口49620-49629),在运行中的EasyEDA Pro客户端内直接执行JavaScript代码,实现毫秒级反馈的实时调试体验。

3. 扩展开发支持
不仅支持Live调试,更完整支持EasyEDA扩展(.eext)开发,提供扩展特有的运行时约束文档、API调用模式、以及主进程与iframe间的数据通信方案。

显著优点

  • 官方维护:嘉立创EDA官方出品,API与软件版本同步更新
  • 类型完备:完整的TypeScript定义,开发时智能提示与类型检查
  • 实时调试:代码即时在EDA客户端执行,无需编译/打包/重启
  • 多窗口支持:可同时连接多个EasyEDA窗口,灵活切换操作目标
  • 生产就绪:支持扩展打包发布至官方扩展市场

潜在局限

  • 版本锁定:仅兼容EasyEDA Pro桌面版(专业版),不支持标准版
  • 运行依赖:需要Node.js 18+环境,且桥接服务器需常驻后台
  • 浏览器沙箱:扩展主进程禁止标准浏览器API(localStorage、alert等),必须使用EDA封装替代方案
  • 权限受限:部分API受用户许可证/项目设置限制,可能返回null或报错
  • 单位陷阱:PCB(1mil)与原理图(0.01inch)坐标单位不同,极易出错

典型应用场景

  • 批量生成PCB封装或原理图符号
  • 自动化设计规则检查(DRC)与报告
  • 跨项目元件库同步与版本管理
  • 定制化设计流程工具开发
  • 企业级EDA工作流集成

风险提醒

  • 务必 await:90%+ API返回Promise,遗漏await将得到挂起的Promise而非结果
  • 务必查文档:API签名差异大,禁止凭直觉猜测参数顺序或类型
  • 务必开项目:操作文档前必须先打开项目(openProject),创建≠打开
  • 务必选对文档类型:PCB API需激活PCB文档,原理图API需激活原理图文档

适合人群

硬件工程师、EDA工具开发者、PCB设计自动化工程师、电子研发团队的技术负责人,以及需要将EDA流程集成至CI/CD或企业PLM系统的开发者。

安全解读

核心用法

本技能是嘉立创EDA官方为EasyEDA Pro专业版打造的AI编程接口,通过WebSocket桥接技术实现AI Agent与运行中EDA客户端的双向通信。核心架构包含:本地Node.js桥接服务器(端口49620-49629自动扫描)、EasyEDA端扩展插件(run-api-gateway.eext)、以及完整的120+类API参考文档体系。

用户说出触发词"嘉立创EDA,启动!"后,AI将建立会话、启动桥接服务、引导用户安装扩展插件,最终形成"AI Agent ↔ Bridge Server ↔ EasyEDA Pro"的三方通信链路。此后AI可执行:项目与工程管理、原理图页面操作、PCB图元创建与修改、元件库查询、设计规则检查(DRC)等全栈EDA操作。

代码执行采用浏览器沙箱环境,eda对象为全局API入口,所有异步方法必须await,返回值必须通过return回传。PCB坐标单位为1mil,原理图为0.01inch(10mil),二者不可混用。

显著优点

官方权威背书:由JLCEDA官方维护,API文档与产品版本同步更新,120+类、62枚举、70接口的完整类型定义覆盖DMT(文档管理)、PCB、SCH(原理图)、LIB(库)、SYS(系统)五大域。

实时双向交互:区别于文件导出/导入的离线模式,WebSocket桥接支持毫秒级指令响应,AI可实时读取选中状态、获取当前工程信息、监听用户操作事件,实现真正的协同设计。

扩展开发赋能:不仅支持单次调试,更提供完整的扩展开发指南——从菜单注册、对话框调用到IFrame沙箱UI,AI可辅助开发者编写符合EasyEDA规范的.eext扩展包。

多窗口智能管理:自动发现多个EDA窗口,支持动态切换目标窗口,满足复杂多屏开发场景。

潜在缺点与局限性

环境依赖较重:必须同时满足Node.js 18+、EasyEDA Pro桌面版、扩展插件三重前置条件,任一环节缺失将导致链路中断。Windows/Mac/Linux跨平台行为可能存在细微差异。

权限与版本限制:部分API受用户许可证等级约束,免费版与专业版功能边界不一致;API行为随EasyEDA版本迭代可能变化,需持续关注兼容性。

异步模式复杂度:PCB图元修改必须遵循"获取→toAsync()→批量设值→done()"四步模式,与传统同步编程心智模型差异较大,AI生成代码时易遗漏await或误用同步方法。

坐标单位陷阱:PCB(1mil)与原理图(0.01inch)单位差异达10倍,是AI操作失误的高发区,需人工复核关键尺寸。

适合的目标群体

  • 硬件工程师:希望通过自然语言快速完成重复性布局布线、批量修改设计参数
  • 嵌入式开发者:需要AI辅助进行原理图审查、BOM导出、封装选型验证
  • EDA扩展开发者:开发自定义插件、自动化设计流程、团队设计规范检查工具
  • 教育培训机构:编程化演示电路设计流程,构建交互式教学案例
  • 开源硬件社区:批量处理仓库中的PCB项目,自动化生成Gerber与生产文件

使用风险

运行时稳定性:桥接服务器与EDA客户端的WebSocket连接可能因网络抖动、EDA崩溃、窗口关闭而中断,关键操作前需调用/health验证链路状态,并做好异常重连机制。

设计数据安全:AI执行的代码直接操作当前打开的工程文件,存在误删图元、错误修改层叠结构的风险,建议在版本控制(Git)或云端备份保护下进行实验性操作。

性能与超时:复杂查询(如遍历全库搜索器件)可能触发30秒默认超时,需将大任务拆分为批量小操作;长时间运行的桥接服务持续占用Node进程,会话结束后应主动关闭。

代码注入边界:虽然服务本地运行且仅监听127.0.0.1,但POST /execute端点接收任意JavaScript代码并转发至EDA执行,理论上存在恶意代码破坏设计的可能,建议仅在可信环境中启用。

EasyEDA API Skill 内容

guide文件夹
ancillary-projects文件夹
references文件夹
classes文件夹
enums文件夹
interfaces文件夹
types文件夹
scripts文件夹
user-guide文件夹
手动下载zip · 360.6 kB
pro-api-sdk.mdtext/markdown
请选择文件