Kicad 插件 The KiCad Team KiCad 插件系统 Copyright 本文档由其贡献者授予版权 © 2016，如下所示。您可以根据 GNU 通用公共许 可证(http：/www.gnu.org/licenses/gpl.html)版本 3 或更高版本或知识共享许可协 议(http：/creativecommons.org/licenses/by/3.0/)、版本 3.0 KiCad 插件系统简介 KiCad 插件系统是一个使用共享库扩展 KiCad 功能的框架。 使用插件的一个 主要优点是在开发插件时没有必要重建 KiCad 套件; 事实上，可以借助 KiCad 源代码树中的一小组标题构建插件。 通过确保开发人员仅编译与正在开发的 插件直接相关的代码，从而减少每个构建和测试周期所需的时间，在插件开发 期间删除构建 KiCad 的要求极大地提高了工作效率。 插件最初是为 无需对支持的每种新模型类型的 KiCad 源进行重大更改。 插件框架后来被推 广，以便将来开发人员可以创建不同类型的插件。 目前，只有 3D 插件在 KiCad 中实现，但可以想象最终将开发 PCB 插件，以使用户能够实现数据导 入器和导出器。 1.1. 插件类 插件分为插件类，因为每个插件都解决了特定域中的问题，因此需要该域独有 的接口。 例如，3D 模型插件从文件加载 3D 模型数据并将该数据转换为可由

Kicad 插件 Kicad 插件 ii October 31, 2021 Kicad 插件 iii Contents 1 KiCad 插件系统简介 2 1.1 插件类 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 2 1.1.1 插件类：PLUGIN_3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 2 教程：3D 插件类 4 2.1 基本的 3D 插件 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.2 高级 3D 插件 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 3 应用程序编程接口（API） 21 3.1 插件类 API . . . . . . . . . . . . . .

题，并防止网络/原理图中未连接的网络连接。 使用交互式布线时，它会持续 运行设计规则检查，并有助于自动布线各个布线。 Pcbnew 提供了一个飞线显示器，一条连接封装焊盘的飞线连接在原理图上。 这些连接在布线和封装移动时动态移动。 Pcbnew 有一个简单但有效的自动布线器，可以帮助生产电路板。 SPECCTRA dsn 格式的导出/导入允许使用更高级的自动布线器。 Pcbnew 提供专门用于生产超高频微波电路的选项（例如梯形和复杂形式的焊 4.0 版本开始，Pcbnew 使用名为“封装库表”的文件组织封装库。 封装库表 包含一些单独的封装库的描述，以及每个库的“昵称”，用于在引用封装时引用 该库。 Pcbnew 支持几种库，每种都由“插件”支持： KiCad - 以 .pretty 格式存储在本地文件系统上的本机 KiCad 封装库（包含 .kicad_mod 文件的文件夹） Github - .pretty 格式的原生 KiCad 每个库条目必须具有有效的路径和/或文件名，具体取决于库的类型。 路径 可以定义为绝对，相对或环境变量替换（见下文） 必须选择适当的插件类型才能使库成为必需的。必须选择适当的插件类型 才能正确读取库。阅读。 还有一个描述字段用于添加库条目的描述。 选项字段包含特定于插件的特殊 选项，通常为空白。 虽然在同一个表中不能有重复的库昵称，但是在全局和项目特定的封装库表中 都可以有重复的库昵称。 当出现重复的名称时，项目特定的表条目将优先于

. . . . . . . . . . . . 10 2.3.7 使用 KiCad 插件 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 2.3.7.1 安装 KiCad 插件库 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 2.3.8 使用 GitHub 插件 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 2.3.8.1 写入时复制（Copy-On-Write） . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 15.8 动作插件 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

to relocate projects without breaking their project library tables. 使用 GitHub 插件 NOTE KiCad 在 6.0 版本中取消了对 GitHub 库插件的支持。 Shift 67 创建和编辑封装 NOTE This section of the KiCad documentation has not yet 观的预览。 操作插件 KiCad PCB 编辑器支持用 Python 编写的插件，可以对正在编辑的电路板进行操作。 这些插件可以使用内置的插件 和内容管理器来安装（详见 KiCad 章节），或者将插件文件放在用户的插件目录中。 详见下面的脚本部分。 每个被检测到的插件都会在这个偏好设置上显示一排。 插件可以在 PCB 编辑器的顶部工具栏上显示一个按钮。 如果 一个插件的 "显示按钮" 控制没有被选中，它仍然可以从 控制没有被选中，它仍然可以从 "工具" > "外部插件" 菜单中访问。 列表底部的箭头控制允许改变插件在工具栏和菜单中的显示顺序。 文件夹按钮将启动一个文件资源管理器到插件文 件夹，以使安装新的插件更容易。 刷新按钮将扫描插件文件夹中的任何新的或删除的插件，并更新列表。 72 原点和轴 显示原点： 决定在编辑画布中坐标显示使用哪个坐标原点。 页面原点固定在页面的角落。 用户可以移动钻取/放置文

to relocate projects without breaking their project library tables. 使用 GitHub 插件 NOTE KiCad 在 6.0 版本中取消了对 GitHub 库插件的支持。 Migrating footprint libraries to KiCad format Non-KiCad format libraries, including 题外观的预览。 操作插件 KiCad PCB 编辑器支持用 Python 编写的插件，对正在编辑的电路板进行操作。 这些插件可以使用内置的 “插件和内 容管理器” 来安装（详见 KiCad 章节），或者将插件文件放在用户的插件目录中。 详见下面的脚本部分。 每个被检测到的插件都会在这个偏好设置上显示一排。 插件可以在 “PCB 编辑器” 的顶部工具栏上显示一个按钮。 如 果一个插件的 "显示按钮" "显示按钮" 控制没有被选中，它仍然可以从 "工具" > "外部插件" 菜单中访问。 列表底部的箭头控制允许改变插件在工具栏和菜单中的显示顺序。 文件夹按钮将启动一个文件资源管理器到插件文 件夹，以使安装新的插件更容易。 刷新按钮将扫描插件文件夹中的任何新的或删除的插件，并更新列表。 136 原点和轴 显示原点： 决定在编辑画布中坐标显示使用哪个坐标原点。 页面原点固定在页面的角落。 用户可以移动钻孔/拾放文

documentation。 底部窗格列出了基于模式的网络类分配。 每行都有一个网络名称模式和一个网络类； 名称与模式匹配的网络被分配 给指定的网络类。 如果网络匹配多个模式，则使用第一个匹配项。 基于模式的网络类分配是动态的：当添加与现有 模式匹配的新网络时，它将自动分配给关联的网络类。 网络模式可以使用通配符（ * 匹配任意数量的任意字符，包 括无字符，以及 ? 匹配任意字符）和 正则表达式 。匹配所选模式的网络显示在模式列表的右侧。 *显示控制台窗口*选项。当这个选项未被选中时，BOM 生成器 在一个隐藏的控制台窗口中运行，任何输出都会被重定向并打印在对话框中。当该选项被选中时，BOM 生成器在一 个可见的控制台窗口中运行，如果生成器插件提供了一个图形用户界面，这可能是必要的。 BOM 生成器脚本 By default, the legacy BOM tool presents three output script options ）在命令行中具有特殊含义，因为 KiCad 在执行命令之前将它们替换为文件名或路径。 参数 替换为… 描述 %I <工程路径>/<工程名称>.xml 中间网表文件的绝对路径和文件名，它是 BOM 或网表生成器插件 的输入。 %O <工程路径>/<工程名称> 输出 BOM 或网表文件的绝对路径和文件名（没有文件扩展名）。 适当的文件扩展名可能需要在 %O 序列后指定。 %B <工程名称> 输出 BOM

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 10.5.3 转换器和工作表样式 (插件) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 10.5.4 中间网表文件格式 . 网表文件 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 15.3.4 Eeschema 插件界面 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 15.3.4.1 初始化对话窗口 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 15.3.4.2 插件配置参数 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 15.3.4.3

观的预览。 操作插件 KiCad PCB 编辑器支持用 Python 编写的插件，可以对正在编辑的电路板进行操作。 这些插件可以使用内置的插件 和内容管理器来安装（详见 KiCad 章节），或者将插件文件放在用户的插件目录中。 详见下面的脚本部分。 每个被检测到的插件都会在这个偏好设置上显示一排。 插件可以在 PCB 编辑器的顶部工具栏上显示一个按钮。 如果 一个插件的 "显示按钮" 控制没有被选中，它仍然可以从 控制没有被选中，它仍然可以从 "工具" > "外部插件" 菜单中访问。 列表底部的箭头控制允许改变插件在工具栏和菜单中的显示顺序。 文件夹按钮将启动一个文件资源管理器到插件文 件夹，以使安装新的插件更容易。 刷新按钮将扫描插件文件夹中的任何新的或删除的插件，并更新列表。 62 原点和轴 显示原点： 决定在编辑画布中坐标显示使用哪个坐标原点。 页面原点固定在页面的角落。 用户可以移动钻取/放置文 of the named group x. 73 自定义设计规则示例 脚本 脚本允许您使用 Python 语言自动执行 KiCad 中的任务。可以通过 Python "操作插件" 向 KiCad 添加功能，这些插件 可以添加到顶部工具栏。也可以编写与 KiCad 文件交互的独立脚本，例如，从电路板文件自动生成制造输出。 本手册涵盖了一般脚本编写概念。希望编写或修改脚本的用户还应使用 https://docs

昵称是用于将符号分配给元件的简短唯一标识符。符号 由'：'字符串表示。 库路 径 路径指向库位置。 插件 类型 确定库文件格式。 选项 存储库特定选项（如果插件使用）。 说明 简要描述库内容。 3.2.2. 常规选项 显示 网格尺寸 网格大小选择。 建议 使用普通网格（0.050英寸或1,27毫米）。较小 网格 用于元件构建。 默认格式 选中以选择 Pcbnew 作为默认格式。 还可以生成其他格式: Orcad PCB2 CadStar Spice (simulators) 可以添加外部插件来扩展网表格式列表（上图中添加了 PadsPcb 插件）。 有关在《create-a-netlist, Create a Netlist》一章中创建网表的更多信息。 4.4. 注释工具 图标 启动注释工具。 此工具分配对元件的引用。 初始化为默认值 恢复原始设置。 4.6. 物料清单工具 图标 启动物料清单（BOM）生成器。 此工具生成一个列出元件和/或分层 连接（全局标签）的文件。 Eeschema 的 BOM 生成器使用外部插件，可以是 XSLT 或 Python 脚本。 KiCad 程序文件目录中安装了一些示例。 用于 BOM 的一组有用的元件属性包括： 值 - 使用的每个部件的唯一名称。 封装 - 手动输入或反标注（见下文）。