Při návrhu elektroniky v KiCadu obvykle nestačí jen navrhnout schéma a desku plošných spojů. Jakmile je projekt připravený k výrobě, je potřeba vytvořit kompletní sadu výstupních dat: PDF dokumentaci, Gerber data, vrtací soubory, 3D model, osazovací podklady, kusovník, případně také podklady pro JLCPCB. Pokud se tyto kroky provádějí ručně, je snadné na něco zapomenout, zvolit špatné nastavení exportu nebo vytvořit nejednotnou dokumentaci.

Project Releaser je akční plugin pro KiCad – Open Source PCB Design Suite. Je určený pro verzi KiCad 10.0 na platformě Windows. Byl navržen a naprogramován společností WIDE SERVIS. Jeho cílem je vytvořit z otevřeného KiCad projektu kompletní a opakovatelnou sadu release výstupů v profesionální podobě.

Plugin je navržený tak, aby z jednoho dialogového okna vytvořil všechny potřebné výstupy, zkontroloval dostupnost volitelných nástrojů, připravil přehled vygenerovaných souborů a umožnil jejich rychlé otevření a prohlížení.

Hlavní a jediné dialogové okno

K čemu Project Releaser slouží

Project Releaser slouží k automatickému vytvoření release dat KiCad projektu. Typicky se používá ve chvíli, kdy je návrh desky dokončený a je potřeba připravit balíček pro výrobu, montáž, kontrolu nebo archivaci.

Plugin vytváří zejména:

• PDF schéma projektu,
• PDF dokumentaci desky,
• PDF montážní dokumentaci,
• Gerber data,
• vrtací a výrobní soubory,
• ZIP archiv Gerber dat,
• STEP 3D model desky,
• BOM a CPL soubory,
• volitelně JLCPCB BOM a CPL,
• volitelně Assembly Interactive HTML soubor,
• finální archiv release dat.

Výhodou je jednotné nastavení výstupů, opakovatelnost a menší riziko ručních chyb. Každý release projektu je vytvořen stejným postupem, se stejnou strukturou složek a se stejným pojmenováním souborů.

Hlavní výhody

Největší výhodou pluginu je automatizace celého release procesu. Místo ručního spouštění několika exportů v KiCadu stačí použít tlačítko Generate Files. Plugin následně postupně vytvoří dokumentaci, výrobní data, 3D model a další výstupy.

Další výhodou je přehlednost. Vygenerované soubory jsou rozdělené do jasně pojmenovaných složek a po dokončení se zobrazí panel Generated output files, ze kterého lze výstupy rovnou otevřít.

Plugin také řeší běžné praktické detaily:

• nastavuje release datum v popisových polích,
• generuje výstupy do jednotné adresářové struktury,
• umí vytvořit ZIP Gerber dat,
• umí připravit samostatnou složku pro JLCPCB,
• podporuje korekce pozic a rotací pro JLCPCB CPL,
• automaticky instaluje potřebná barevná schémata KiCadu,
• kontroluje dostupnost volitelných nástrojů,
• při archivaci nastavuje timestampy souborů podle zadaného Release Date a Release Time.

Základní použití

Po instalaci se plugin zobrazí v KiCadu jako akční plugin v PCB editoru. Po spuštění se otevře dialog Project Releaser.

V dialogu se nastavuje zejména:

• Release Date,
• Release Time,
• 3D barevný profil pro rendery a STEP model,
• volba generování JLCPCB BOM/CPL,
• případně korekce pro JLCPCB CPL.

Hlavní tlačítko se podle stavu projektu přepíná mezi:

• Generate Files — pokud výstupy ještě neexistují,
• Regenerate Files — pokud už výstupy existují.

Po dokončení generování se zobrazí seznam vytvořených výstupů v panelu Generated output files. U jednotlivých položek je uveden typ výstupu, velikost souboru nebo počet souborů a tlačítko View pro rychlé otevření.

Pokud jsou výstupy připravené, zpřístupní se tlačítko Archive Release, které vytvoří finální archiv release dat. Po vytvoření archivu se pracovní výstupní složky odstraní.

Výstupní složky

Project Releaser vytváří několik hlavních složek přímo v adresáři KiCad projektu.

Documentation

Složka Documentation obsahuje dokumentační výstupy projektu.

Typicky obsahuje:

• PDF schéma,
• PDF dokumentaci desky,
• STEP model desky,
• PNG rendery horní a spodní strany,
• další dokumentační soubory vytvořené během release procesu.

STEP model je generován podle zvoleného barevného profilu. Barva solder masky a potisku se přenáší do dočasné kopie desky pouze pro účely STEP exportu. Originální KiCad projekt se tím nemění.

Fabrication

Složka Fabrication obsahuje výrobní data pro PCB.

Typicky obsahuje:

• Gerber data,
• vrtací soubory,
• další výrobní výstupy,
• ZIP archiv Gerber dat.

ZIP Gerber dat se vytváří už při generování souborů, takže je dostupný ještě před archivací celého release balíčku.

Assembly

Složka Assembly obsahuje podklady pro osazování.

Typicky obsahuje:

• assembly PDF,
• standardní BOM CSV,
• standardní CPL-POS CSV,
• volitelně Assembly Interactive HTML.

Assembly Interactive HTML se generuje pomocí externího pluginu Interactive HTML BOM. Pokud tento plugin není nainstalovaný, Project Releaser tento krok přeskočí a pokračuje dál bez chyby.

JLCPCB

Složka JLCPCB se vytváří pouze v případě, že je aktivní volba Generate BOM/CPL v části JLCPCB Assembly Files.

Obsahuje:

• JLCPCB BOM CSV,
• JLCPCB CPL CSV,
• kopii Gerber ZIP souboru.

Tato složka tak obsahuje vše potřebné pro zadání výroby a osazení u JLCPCB na jednom místě.

JLCPCB soubory se generují pouze pro komponenty, které mají vyplněné pole LCSC nebo JLC. Pokud žádná taková komponenta v projektu není, volba JLCPCB se automaticky deaktivuje.

JLCPCB BOM a CPL

Project Releaser umí generovat JLCPCB soubory ve formátu používaném službou JLCPCB.

BOM obsahuje sloupce:

Comment,Designator,Footprint,LCSC,Quantity

CPL obsahuje sloupce:

Designator,Val,Package,Mid X,Mid Y,Rotation,Layer

Pozice jsou v milimetrech a jsou vztažené k pomocnému/drill originu projektu. Vrstva se zapisuje jako top nebo bottom.

Pro korekce rotací a pozic se používá soubor:

jlcpcb_corrections.csv

Ten je umístěný ve složce pluginu. Korekce se vyhledávají podle názvu footprintu a obsahují:

Footprint Pattern,Rotation,Offset X,Offset Y

Rotace je ve stupních a může být kladná i záporná. Offset X a Offset Y jsou v milimetrech. Posun je definovaný v lokálních souřadnicích footprintu a při výpočtu se zohledňuje rotace i strana desky.

Korekční soubor lze otevřít přímo z dialogu tlačítkem Edit corrections….

Pokud už JLCPCB soubory existují, lze je po úpravě korekcí nebo polí komponent znovu vytvořit tlačítkem Regenerate BOM/CPL. Tato akce přegeneruje pouze JLCPCB BOM a CPL, nikoli Gerber data.

Barevné profily a výstupy PDF

Project Releaser používá pro generování dokumentačních PDF výstupů barevná schémata KiCadu. Potřebná schémata jsou součástí pluginu ve složce:

colors

Při spuštění plugin zkontroluje konfigurační složku KiCadu a případně chybějící schémata zkopíruje do KiCad konfigurace. Existující uživatelské soubory nepřepisuje.

Díky tomu jsou PDF dokumentace a assembly výstupy generovány s jednotným vzhledem.

Generated output files

Po úspěšném generování se vpravo vedle logovacího okna zobrazí panel Generated output files.

Panel ukazuje dostupné výstupy, například:

• Schematic PDF,
• PCB documentation PDF,
• Assembly PDF,
• STEP model,
• Gerber ZIP,
• Fabrication files,
• BOM CSV,
• CPL-POS CSV,
• JLCPCB BOM,
• JLCPCB CPL,
• Assembly Interactive.

U každé položky je uvedena velikost nebo počet souborů a tlačítko View. Běžné soubory se otevírají v aplikaci podle systémové asociace. Pokud je nakonfigurován externí Gerber prohlížeč, lze přímo otevřít i Gerber production data.

Archivace release dat

Tlačítko Archive Release je aktivní pouze tehdy, když existují vygenerovaná release data.

Při archivaci se vytvoří finální ZIP archiv. Plugin nastaví timestampy souborů podle hodnot Release Date a Release Time zadaných v GUI. To platí i pro soubory uvnitř vnořených ZIP archivů, například Gerber ZIPu.

Po úspěšné archivaci se pracovní výstupní složky odstraní.

Konfigurace

Konfigurace uživatelských cest je v souboru:

project_releaser_config.csv

Formát souboru je:

Key,Path,Description

Aktuálně podporované položky:

gerber_viewer_exe,C:/PAF/ZofzPCB/ZofzPCB-pal.exe,External GERBER viewer executable
gerber_viewer_temp_dir,D:/Projects/PCB_designs/_GERBER-FABRICATION/,Temporary GERBER viewer data directory
interactive_html_bom_dir,../InteractiveHtmlBom,Interactive HTML BOM plugin directory

Cesty mohou být absolutní nebo relativní vůči složce pluginu. Pokud konfigurační soubor neexistuje, plugin ho automaticky vytvoří s prázdnými cestami.

Pokud není externí Gerber prohlížeč nalezen, Project Releaser jednoduše nezobrazí možnost otevření Gerber production data. Ostatní výstupy zůstávají funkční.

Pokud není nainstalovaný Interactive HTML BOM plugin, Project Releaser přeskočí generování Assembly Interactive výstupu a pokračuje dál.

Požadované závislosti

Project Releaser používá knihovnu PyMuPDF pro práci s PDF soubory. Pokud není nainstalovaná, plugin se v KiCadu zobrazí, ale v dialogu zůstane aktivní pouze tlačítko Exit a v logu se zobrazí instalační instrukce.

Instalace se provádí z KiCad Command Prompt:

python -m pip install --upgrade PyMuPDF

Po instalaci je potřeba restartovat KiCad.

Volitelné nástroje:

• Interactive HTML BOM plugin,
• externí Gerber prohlížeč, například: ZofzPCB – FREE 3D Gerber Viewer,
• aplikace asociovaná se soubory STEP, například: eDrawings – FREE nástroj pro prohlížení 3D modelů.

Instalace

Instalace pluginu je jednoduchá:

1. Rozbalit složku ProjectReleaser do adresáře KiCad pluginů.
2. Spustit nebo restartovat KiCad.
3. V případě potřeby nainstalovat PyMuPDF pomocí KiCad Command Prompt:

python -m pip install --upgrade PyMuPDF

4. Otevřít PCB editor.
5. Spustit plugin Project Releaser z panelu akčních pluginů.
6. Podle potřeby upravit project_releaser_config.csv.

Plugin je dodáván včetně potřebných jobsetů, barevných schémat, ikon, fontu a výchozích konfiguračních souborů.

Shrnutí

Project Releaser je nástroj pro automatizované a profesionální vytváření release dat z KiCad projektů. Pomáhá udržet jednotný proces, snižuje riziko ručních chyb a zjednodušuje přípravu podkladů pro výrobu, montáž, kontrolu a archivaci.

Je určený pro uživatele, kteří chtějí mít výstupní data z KiCadu přehledná, opakovatelná a připravená jedním kliknutím.