EasyEDA API Skill

⚡ AI 驱动的硬件设计自动化引擎

设计榜 #14

通过 AI 代理直接控制 EasyEDA Pro 的完整 API 套件,支持 PCB/原理图自动化设计、扩展开发与实时调试,含 120+ 类、WebSocket 桥接器及源代码格式参考。

收藏
15.6k
安装
6.1k
版本
1.1.2
CLS 安全性认证2026-07-14
点击查看完整报告 >

使用说明

核心功能

EasyEDA Pro API Skill 是专为 AI 代理设计的嘉立创EDA专业版程序化控制工具,提供四大核心能力:

1. 完整 API 参考体系

  • 120 个类、62 个枚举、70 个接口、19 个类型别名
  • 覆盖文档管理(DMT_)、PCB设计(PCB_)、原理图(SCH_)、库管理(LIB_)、系统(SYS_)全领域
  • 详细的方法签名、参数类型、返回值及使用备注

2. WebSocket 桥接架构

  • Node.js 桥接服务器(端口 49620-49629 自动选择)
  • AI 代理通过 HTTP/WS 与运行中的 EasyEDA Pro 客户端通信
  • 支持代码在 EDA 浏览器运行时中直接执行

3. 源代码格式参考

  • 项目、原理图、PCB 文档的底层 JSON 结构规范
  • 用于直接分析或生成兼容的文档源数据

4. 扩展开发支持

  • 完整的扩展开发文档与运行时约束说明
  • 提供标准浏览器 API 的 EDA 替代方案(对话框、存储、IFrame 等)

显著优点

| 优势 | 说明 |
|------|------|
| **官方权威性** | 由 JLCEDA(嘉立创EDA团队)直接维护,API 文档与软件版本同步 |
| **功能全覆盖** | 从基础图元操作到项目/团队/工作区管理,无功能盲区 |
| **实时调试能力** | 桥接器支持即时代码执行,开发调试循环极短 |
| **多窗口支持** | 可同时连接多个 EDA 实例,灵活切换工作窗口 |
| **类型安全导向** | 强制使用枚举(如 `EPCB_LayerId.TOP` 而非 `1`),减少隐性错误 |
| **详尽错误预防** | 文档明确标注常见陷阱(坐标单位混淆、Promise 未 await、文档状态检查等) |

潜在局限与风险

技术约束:

  • 必须运行 EasyEDA Pro 桌面客户端(不支持网页版)
  • 需安装专用扩展 run-api-gateway.eext 作为桥接端点
  • Node.js 18+ 环境依赖

使用门槛:

  • API 体量庞大,初学者需时间熟悉模块命名规范(DMT_/PCB_/SCH_/LIB_/SYS_)
  • 坐标单位易混淆:PCB 使用 1mil,原理图使用 0.01inch(10mil),错误会导致 10 倍位置偏差
  • 异步模式修改图元时需严格遵循 get() → toAsync() → setState_*() → done() 流程

安全与权限:

  • 操作直接作用于用户的工程文件,误操作可能导致数据丢失
  • 部分 API 受 EDA 权限系统限制,特定功能可能需要商业授权或特定版本
  • 扩展开发中禁止使用标准浏览器 API(alert/confirm/localStorage 等),必须使用 EDA 封装替代

稳定性考量:

  • WebSocket 连接可能因 EDA 客户端重启、网络波动中断
  • 复杂操作可能触发 30 秒超时,需合理拆分任务

适用人群

  • 硬件工程师:批量处理 PCB 设计、自动化 DRC 检查、生成标准化文档
  • EDA 扩展开发者:开发 EasyEDA Pro 插件、自定义工具面板、集成外部工作流
  • 自动化测试团队:构建 CI/CD 流水线中的设计规则验证
  • 教育/培训机构:程序化生成教学用原理图与 PCB 案例

常规风险管控

| 风险场景 | 防护措施 |
|----------|----------|
| 错误单位导致布局混乱 | 操作前强制确认文档类型,使用枚举常量而非裸数值 |
| Promise 未 await 产生静默失败 | 文档明确标注所有异步方法,代码生成时强制检查 `return await` 模式 |
| 未打开项目/文档导致 API 失效 | 执行核心操作前必须调用 `getCurrentProjectInfo()` 和 `getCurrentDocumentInfo()` 验证 |
| 扩展中误用浏览器 API | 提供对照表自动替换,运行时严格隔离主进程与 IFrame 上下文 |
| 多窗口状态混乱 | 首次操作时确认窗口选择,断连时主动引导重新选择 |
| 资源泄漏 | 话题切换 3 次后主动询问是否关闭桥接服务器 |

安全解读

核心用法

本Skill为AI代理提供完整的EasyEDA Pro(嘉立创EDA专业版)API控制能力,采用"桥接服务器+WebSocket"架构实现双向通信:

1. 桥接服务器:Node.js本地服务(端口49620-49629),作为AI与EasyEDA客户端的中转站
2. 扩展网关:用户需安装run-api-gateway.eext扩展建立WebSocket连接

3. 代码执行:AI生成JavaScript代码,通过HTTP POST发送至桥接服务器,在EasyEDA浏览器环境中执行并返回结果

典型工作流:启动桥接 → 安装扩展 → 验证连接 → 查询API文档 → 生成代码 → 执行验证 → 迭代调试。

显著优点

  • 官方权威:JLCEDA官方维护,T2级可信来源,API文档完整(120+类、62枚举、70接口)
  • 实时交互:代码在运行中的EasyEDA客户端直接执行,无需导出/导入文件
  • 全功能覆盖:涵盖项目管理、原理图/PCB编辑、库操作、扩展开发四大领域
  • 文档详尽:包含快速参考、详细类文档、枚举值说明及源代码格式规范
  • 多窗口支持:可同时连接多个EasyEDA实例,按需切换
  • 安全隔离:纯本地服务,无外发网络请求,代码在沙箱环境中运行

潜在缺点与局限性

  • 环境依赖重:需同时运行Node.js桥接服务器、EasyEDA桌面客户端、API网关扩展,配置门槛较高
  • 状态敏感:操作前必须确认项目已打开、文档类型匹配(PCB/原理图),否则API返回null或报错
  • 单位易混淆:PCB使用1mil单位,原理图使用0.01inch(10mil),误用会导致10倍位置偏差
  • 异步模式复杂:修改PCB图元需get() → toAsync() → setState_*() → done()四步流程,新手易出错
  • 权限限制:部分API受EDA版本/许可证限制,可能无错误提示即失败
  • 调试门槛:WebSocket连接中断、扩展未加载等故障需逐步排查

适合人群

  • 硬件工程师:需批量操作元件、自动化DRC检查、生成定制化报表
  • 扩展开发者:基于EasyEDA平台开发插件,需查阅API文档和调试代码
  • AI辅助设计探索者:尝试用自然语言驱动EDA操作,快速验证电路方案
  • 教育/培训机构:演示PCB设计流程,自动化生成教学示例

常规风险

1. 数据丢失风险openProject()会丢弃当前未保存的更改,操作前需提醒用户保存
2. 坐标单位错误:未仔细核对单位常导致元件放置严重偏离,建议执行前二次确认

3. 权限误判:API调用失败时,需优先排查文档状态而非代码逻辑,避免无效调试

4. 会话残留:桥接服务器后台持续运行,切换话题后应询问用户是否关闭以释放资源

5. 多窗口混淆:多实例场景下需明确告知用户当前激活窗口,避免误操作非目标项目

EasyEDA API Skill 内容

format文件夹
pcb文件夹
project文件夹
schematic文件夹
guide文件夹
ancillary-projects文件夹
references文件夹
classes文件夹
enums文件夹
interfaces文件夹
types文件夹
scripts文件夹
user-guide文件夹
手动下载zip · 404.5 kB
3d.mdtext/markdown
请选择文件