“很多小伙伴都想自己開發 KiCad 插件，但不知從何入手。本文由華秋電子的另一位 KiCad 開發者波波同學撰寫，分享了如何快速搭建環境，并開發一個簡單的插件。”

所有環境配置成功，接下來可以寫我們的python插件了。按照 kicad官方開發手冊，實現一個顯示PCB對應圖層的插件：

https://dev-docs.kicad.org/zh-cn/apis-and-binding/pcbnew/index.html

插件文件夾結構如下：

• kicad_plugin/#插件目錄(Python包)

• - __init__.py #此文件在導入軟件包時執行(在Pcbnew啟動時)

• - __main__.py #調試python代碼時使用

• - action_plugin.py # ActionPlugin派生類位于此處

• - icon.png #插件圖標

• - main_frame_view.py #其他Python代碼

• - ui_main_frame.fbp # wxformbuilder生成的源代碼

• - ui_main_frame.py # wxformbuilder生成的python代碼

[插件示例倉庫]:

https://github.com/Huaqiu-Electronics/my-kicad-plugin.git

1、插件頁面布局。

上文通過wxformbuilder生成了ui_main_frame.py的UiMainFrame類。新建 main_frame_view.py 文件，定義一個名為MainFrameView的類，它繼承自UiMainFrame，MainFrameView 繼承了 UiMainFrame 的所有屬性和方法。初始化一個帶有兩列的self.data_view_list控件，并設置列的樣式。

• AppendTextColumn()方法用于向DataView中添加一個文本列。

fromui_main_frameimportUiMainFrame
classMainFrameView(UiMainFrame): def__init__(self, parent):   super().__init__(parent)     self.data_view_list.AppendTextColumn(     "ID",     0,      width=50,      align=wx.ALIGN_CENTER,      flags=dv.DATAVIEW_COL_RESIZABLE,    )    self.data_view_list.AppendTextColumn(     "Layer",     1,      width=170,      align=wx.ALIGN_CENTER,      flags=dv.DATAVIEW_COL_RESIZABLE,    )

2、加載PCB對象。

首先嘗試獲取當前 PCB 文件的文件名。pcbnew.GetBoard()返回當前加載的 PCB 對象，并將 PCB 對象賦值給self.board 。如果加載失敗，則嘗試加載一個指定路徑的文件，使用pcbnew.LoadBoard() 方法加載該pcb文件，并將返回的 PCB 對象賦值給 self.board。

   try:     #通過 kicad 打開插件時調用      pcbnew.GetBoard().GetFileName()     self.board = pcbnew.GetBoard()    exceptExceptionase:     # VSCode 調試插件時調用      fp ="C:\Program Files\demos\flat_hierarchy\flat_hierarchy.kicad_pcb"# Replace with your own PCB file path.     ifos.path.exists(fp):       self.board = pcbnew.LoadBoard(fp)     else:       print("File not find")

3、從 KiCad 的 PCB 文件中獲取可見圖層的信息，并將這些信息添加到一個DataView控件中。

• GetVisibleLayers() 方法返回一個包含所有可見圖層的集合。

• GAL_LayerSet 是用于管理KiCad 圖層的類。

• gal_set.Seq() 返回一個包含所有可見圖層編號的序列。

• AppendItem(data) 方法將 data 列表中的內容作為一行添加到 DataView 控件中。

 deffill_list_data(self):    data = []    gal_set = self.board.GetVisibleLayers()   fornumin[xforxingal_set.Seq()]:      layerName = self.board.GetLayerName(num)      data = [str( num ), layerName ]      self.data_view_list.AppendItem(data)

4、顯示特定圖層的實現。

on_show_layer()方法是一個事件處理函數，用于在 KiCad 的 GUI 中顯示或隱藏特定的圖層。on_show_layer() 方法與一個事件項關聯綁定，當用戶觸發該事件時，它會根據用戶在DataView控件中的選擇來顯示特定圖層。

• GetSelectedRow()方法返回當前選中的行索引。
• GetValue(row, column)方法獲取指定行和列的值。
• SetVisibleLayers(gal_set)設置可見圖層集合。

• UpdateUserInterface()方法更新 KiCad 的用戶界面，以反映圖層的更改。

  def on_show_layer(self, event):    selection = self.data_view_list.GetSelectedRow()    item_data = self.data_view_list.GetValue(selection,0)    self.board.SetVisibleAlls()    gal_set = self.board.GetVisibleLayers()    for num in [x for x in gal_set.Seq()]:      ifstr(num) == item_data:        continue      gal_set.removeLayer(num)    self.board.SetVisibleLayers(gal_set)    pcbnew.UpdateUserInterface()    wx.CallAfter(pcbnew.Refresh)    event.Skip()    pass

• dv.EVT_DATAVIEW_SELECTION_CHANGED 是一個事件類型，表示用戶通過單擊激活數據項。

   self.data_view_list.Bind(      dv.EVT_DATAVIEW_SELECTION_CHANGED,self.on_show_layer    )

5、啟動一個基于wxPython的獨立應用程序。

在__main__.py中啟動插件。從 wx 模塊中導入 App 類，定義一個名為StandAloneApp的類繼承自 App。StandAloneApp用于管理應用程序的生命周期，并在主程序中實例化該類，顯示主窗口。

• Show()方法顯示主窗口。

• app.MainLoop()方法啟動應用程序的主事件循環。MainLoop負責處理用戶交互、窗口更新等事件。

fromwximportApp
classStandAloneApp(App): # StandAloneApp 類繼承自 wx.App。用于管理應用程序的生命周期。 def__init__(self):   super().__init__()
if__name__ =="__main__":  app = StandAloneApp() frommain_frame_viewimportMainFrameView  MainFrameView(None).Show()  app.MainLoop()

6、通過VSCode調試KiCad插件，在__main__.py頁面下，點擊“Python Debugger:Debuge Python File”，出現GUI圖形界面則表示運行成功。到這里KiCad插件調試成功。

7、定義 KiCad 插件。

action_plugin.py 定義一個名為 Plugin 的類，繼承自 pcbnew.ActionPlugin。ActionPlugin 是 KiCad 提供的基類，用于創建插件。當用戶通過菜單或工具欄按鈕觸發插件時，Run() 方法被調用，顯示插件的主界面。

• self.name設置插件的名稱，顯示在 KiCad 的菜單或工具欄中。
• self.category設置插件的類別，用于在 KiCad 的菜單中組織插件。

• self.description 插件的功能描述，顯示在 KiCad 的插件管理器中。

• self.icon_file_name 設置插件的圖標文件路徑。

• self.dark_icon_file_name 設置插件的深色模式圖標文件路徑。

importpcbnewimportosimportwx
# 插件入口classPlugin(pcbnew.ActionPlugin): def__init__(self):    self.name ="MyPlugin"# 插件名稱    self.category ="Manufacturing"# 描述性類別名稱    self.description ="To show or to hide layer."# 對插件及其功能的描述    self.show_toolbar_button =True# 可選，默認為 False    self.icon_file_name = os.path.join(os.path.dirname(__file__),"icon.png") # 可選，默認為 ""    self.dark_icon_file_name = os.path.join(os.path.dirname(__file__),"icon.png")
 defRun(self):   frommain_frame_viewimportMainFrameView    MainFrameView(None).Show()

8、在kicad中加載和注冊插件。

• PLUGIN_ROOT設置為當前腳本文件所在的目錄路徑。
• Plugin().register() 創建Plugin類的一個實例，并調用該實例的register()方法注冊插件。

importsysimportos
PLUGIN_ROOT=os.path.dirname(os.path.abspath(__file__))
ifPLUGIN_ROOT not in sys.path:  sys.path.append(PLUGIN_ROOT)
from action_pluginimportPluginPlugin().register()

9、插件代碼完成之后就可以使用自己編寫的插件了。在PCB中打開“工具-->外部插件-->打開插件目錄”，進入到插件目錄，將插件頁面放在kicad插件目錄下面：”C:UsershafDocumentsKiCad9.0scriptingplugins”或同級目錄下的”C:UsershafDocumentsKiCad9.03rdpartyplugins”。插件如下圖，通過點擊就可以顯示對應的PCB圖層了。

結束語

編寫KiCad插件是一個需要深入了解KiCad API的過程，而且代碼的具體實現細節可能會比較復雜。如果你在開發過程中遇到具體的問題，可以查閱KiCad的 官方文檔或在相關的開發者社區尋求幫助。此外，確保你的代碼能夠適應KiCad版本的更新，以保持插件的長期可用性。

另外，從 KiCad 9 開始，將逐漸使用 IPC API 逐漸取代原來的 SWIG 方式。詳情可以參考：KiCad 9 引入新的API機制。