Home

Awesome

SparkFun PCB Panelizer plugin for KiCad 7 / 8

This plugin converts a single PCB into a panel of multiple PCBs, separated by v-score grooves.

Panelizer

We've tried to keep this panelizer simple and easy-to-use, while also including all of the features of the original SparkFun Panelizer for Eagle. If you need a more comprehensive panelizer which supports tabs, rounded corners, mouse-bites and a whole bunch of other features, please check out Jan Mrázek (@yaqwsx)'s KiKit.

Limitations

This is a simple panelizer. Simple to install, simple to use. Simple to write and maintain too. As such, it has limitations...:

Installation and Usage

Open the KiCad Plugin and Content Manager (PCM) from the main window and filter for SparkFun Panelizer.

To install manually, open the GitHub Repo Releases page and download the SparkFunKiCadPanelizer-pcm.zip file attached to the latest release. Then use the PCM Install from File... option and select the .zip file to install it. For best results, Uninstall the previous version first, Apply Pending Changes, and then Install from File....

Install manually

The panelizer plugin runs inside the KiCad PCB Editor window. (Although you can run the panelizer in a Command Prompt too. See below for details.)

Click the four flame panelizer icon to open the panelizer GUI:

Open panelizer

We have deliberately kept the GUI options as simple as possible. (More options are available in the Command Prompt).

Click Panelize to panelize the board.

Run panelizer

The panel is automatically saved to a sub-folder called Production and has "panelized" included in the file name. KiCad will save it as a separate project, with its own separate backups. Remember to re-open your original PCB afterwards.

The panelizer settings are saved in a file called panel_config.json so they can be reused.

SparkFun ordering instructions are saved in ordering_instructions.txt. These are generated from the logos and text found in the PCB drawing.

panelizer.log contains useful diagnostic information. If the PCB fails to panelize, you will find the reason why in panelizer.log.

License and Credits

The code for this plugin is licensed under the MIT license. Please see LICENSE for more info.

panelizer.py is based heavily on Simon John (@sej7278)'s version of Willem Hillier (@willemcvu)'s kicad-panelizer.

The wxFormBuilder text_dialog.fbp and associated code is based on Greg Davill (@gregdavill)'s KiBuzzard.

How It Works

The plugin GUI itself is designed with wxFormBuilder and stored in text_dialog.fbp. Copy and paste the wx Python code from wxFormBuilder into ./SparkFunKiCadPanelizer/dialog/dialog_text_base.py.

.github/workflows/build_asset_release.yml generates the .zip file containing the plugin Python code (./plugins), icon (./resources) and the Plugin and Content Manager (PCM) metadata.json. The workflow automatically attaches the zip file to each release as an asset. Edit ./SparkFunKiCadPanelizer/resource/_version.py first and update the version number. build.py is called by the workflow, copies metadata_template.json into metadata.json and then updates it with the correct version and download URL. The version number is also added to the .zip filename. The PCM should automatically download and install new versions of the panelizer for you.

You can run the panelizer stand-alone if you want to. Open a KiCad 7.0 Command Prompt. On Windows, you will find this in Start Menu / All Apps / KiCad 7.0. cd to the SparkFun_KiCad_Panelizer\SparkFunKiCadPanelizer\panelizer directory. python panelizer.py will show the help for the arguments. When you run the panelizer plugin in KiCad, it will panelize whichever PCB is currently open and save the panel into a copy with the suffix _panelized.kicad_pcb. When running the panelizer stand-alone, you need to provide the path -p to the PCB to be panelized. But again the panel is saved as a separate copy.