Compare commits

..

16 Commits

Author SHA1 Message Date
L'électron rare 2402288a2b feat: ajout d'un fichier README_FR.md et mise à jour du README.md avec un lien de parrainage 2026-03-26 07:57:20 +01:00
Benny Megidish 51fe5fc3f4 Update README.md 2025-12-14 19:48:09 +02:00
Benny Megidish 8c4c341b10 Merge branch 'master' of https://github.com/bennymeg/JLC-Plugin-for-KiCad 2025-12-14 18:49:22 +02:00
Benny Megidish 605756ddb1 chore: invert backup flag + fix checkbox ui bug 2025-12-14 18:44:56 +02:00
Lukas Lang 7ac0af4ccf fix: crash when trying to rename non-existent designators/BOM/positions files (#225) 2025-12-05 13:50:10 +02:00
Benny Megidish 8c3a4ba784 Merge branch 'master' of https://github.com/bennymeg/JLC-Plugin-for-KiCad 2025-10-30 22:00:18 +02:00
Benny Megidish 3f9d135e66 chore: bump version (5.2.0) 2025-10-30 22:00:11 +02:00
Neil Enns 1e25598c4e fix: noBackup CLI option (#222) 2025-10-14 21:00:33 +03:00
Benny Megidish 6393fd89d8 feat: restore design setting after plotting. #208 2025-10-13 10:37:16 +03:00
Benny Megidish 87fe0fc675 chore: rewording 2025-10-13 10:22:18 +03:00
Neil Enns a20484abc5 feat: add support for a --noBackup flag and UI checkbox & dev containers (#221)
* Add vscode devcontainer

* Add test files to gitignore

* Add --noBackup flag

* Update installer
2025-10-13 09:18:09 +03:00
Peter Jaquiery 3381050309 feat: skip empty MPNs, update image asset (#191)
* Correct PNG for Symbol Properties dialog to show "FT Rotation Offset" rather than "JLCPCB Rotation Offset" to match readme and code behaviour.

* Continue field search in MPN handling if selected field is empty.

---------

Co-authored-by: Benny Megidish <bennymegk@gmail.com>
2025-10-03 14:14:27 +03:00
WilheJo 6a2804ef19 feat: rename unzipped files if archive gets a user defined name (#210) 2025-10-03 13:59:00 +03:00
wenzellabs d047824964 feat: allow 'Part Number' as BOM keyword, add checkbox whether browser opens (#213)
* allow 'Part Number' as BOM keyword

Signed-off-by: matthias wenzel <wenzel@wenzellabs.de>

* add a checkbox 'Open browser after generation'

Signed-off-by: matthias wenzel <wenzel@wenzellabs.de>

* document 'Part Number' as BOM field

Signed-off-by: matthias wenzel <wenzel@wenzellabs.de>

---------

Signed-off-by: matthias wenzel <wenzel@wenzellabs.de>
2025-10-03 13:48:27 +03:00
Benny Megidish da738d6423 chore: update README.md 2025-09-18 12:50:00 +03:00
Antonín Skala 2894567147 feat: add nonInteractive mode (#212) 2025-08-02 21:04:04 +03:00
13 changed files with 362 additions and 55 deletions
+17
View File
@@ -0,0 +1,17 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/python
{
"name": "Python 3",
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"ghcr.io/devcontainers/features/python:1": {},
"ghcr.io/stuartleeks/dev-container-features/shell-history:0": {},
"ghcr.io/neilenns/devcontainer-features/oh-my-zsh": {
"disableAutoUpdate": false,
"disableUpdatePrompt": false,
"stripWorkspacesFromPrompt": true,
"theme": "agnoster"
}
},
"postCreateCommand": ".devcontainer/install-kicad.sh"
}
+22
View File
@@ -0,0 +1,22 @@
#!/bin/bash
set -e
echo "Installing prerequisites..."
sudo apt update > /dev/null 2>&1 && sudo apt install -y software-properties-common > /dev/null 2>&1
echo "Installing KiCad (takes a few minutes)..."
sudo add-apt-repository -y ppa:kicad/kicad-9.0-releases > /dev/null 2>&1
sudo apt update > /dev/null 2>&1
sudo apt install -y --no-install-recommends kicad kicad-symbols kicad-footprints > /dev/null 2>&1
# Link KiCad plugin to workspace path
echo "Linking KiCad plugin..."
mkdir -p "$HOME/.local/share/kicad/9.0/3rdparty/plugins"
ln -s /workspaces/Fabrication-Toolkit/plugins "$HOME/.local/share/kicad/9.0/3rdparty/plugins/com_github_bennymeg_JLC-Plugin-for-KiCad"
mkdir -p "$HOME/.local/share/kicad/9.0/3rdparty/resources"
ln -s /workspaces/Fabrication-Toolkit/resources "$HOME/.local/share/kicad/9.0/3rdparty/resources/com_github_bennymeg_JLC-Plugin-for-KiCad"
# Add plugin to PYTHONPATH
echo "Adding plugin to PYTHONPATH..."
echo 'export PYTHONPATH="$PYTHONPATH:$HOME/.local/share/kicad/9.0/3rdparty/plugins"' >> "$HOME/.zshrc"
+2 -1
View File
@@ -1,4 +1,5 @@
.venv
dist/
.DS_Store
*.pyc
*.pyc
Test/
+1
View File
@@ -14,6 +14,7 @@
"LCSC",
"LQFP",
"LSEQ",
"Megidish",
"MSOP",
"netlist",
"panelization",
+41 -29
View File
@@ -1,12 +1,13 @@
<img src="https://github.com/bennymeg/JLC-Plugin-for-KiCad/blob/master/assets/logo.svg?raw=true"
<img src="https://github.com/bennymeg/JLC-Plugin-for-KiCad/blob/master/assets/logo.svg?raw=true"
style="display:block margin-left: auto; margin-right: auto;" alt="JLC PCB Plug-in for KiCad">
<div align="center">
| **JLC PCB Plug-in for KiCad** |
|:-----:|
[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/bennymeg)
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/bennymeg/fabrication-toolkit/total)
</div>
@@ -27,11 +28,10 @@ Fabrication Toolkit is distributed with the official releases of KiCad 6+. Open
Download the [latest release](https://github.com/bennymeg/JLC-Plugin-for-KiCad/releases) ZIP file. Open the "Plugin and Content Manager" from the KiCads main window and install the ZIP file via "Install from File".
## Usage
Click on the Fabrication Toolkit <img src="https://github.com/bennymeg/JLC-Plugin-for-KiCad/blob/master/resources/icon.png?raw=true" style="margin-bottom: 8px;" alt="Logo" height=24> button on the top tool box inside KiCad pcb editor (pcbnew).
Click on the Fabrication Toolkit <img src="https://github.com/bennymeg/JLC-Plugin-for-KiCad/blob/master/resources/icon.png?raw=true" style="margin-bottom: 8px;" alt="Logo" height=24> button on the top tool box inside KiCad pcb editor (pcbnew), choose the required options and click on 'Generate'.
**⊛** Ensure your board is synchronized before invoking this addon [**F8**].
**⊛** The `User_1` layer in internally defined as a **V-Cuts** layer, please avoid using it for anything else (unless disabled). <span style="text-color: light-grey !important;">_(since v3.0.0)_.</span>
> [!IMPORTANT]
> Ensure your board is synchronized before invoking this addon [**F8**].
## Options
@@ -43,10 +43,17 @@ Options can be set in the dialog that appears when the plugin is invoked. They a
__Additional layers__: Comma-separated list of additional layers to include in the gerber archive.</br>
__Plot all active layers__: Whether to include all layers, instead of just the layers required by JLCPCB.</br>
__Set User.1 as V-Cut layer__: Merge User.1 layer with the Edge-Cut layer in production.</br>
__Use User.2 for an alternative Edge-Cut layer__: Use the User.2 instead of the Edge-Cut layer for the board outline in production. This is useful if you need process edges or panelization during production but still want to keep the individual outline for prototyping, 3D model exports, or similar purposes.</br>
__Use User.2 for an alternative Edge-Cut layer__: Use the User.2 instead of the Edge-Cut layer for the board outline in production.
This is useful if you need process edges or panelization during production but still want to keep the individual outline for prototyping, 3D model exports, or similar purposes.</br>
__Apply automatic translations__: Apply known translation fixes for common components.</br>
__Apply automatic fill for all zones__: Refill all zones before generation production files.</br>
__Exclude DNP components from BOM__: Exclude components the had been set a DNP from th BOM.</br>
__Generate Backups__: Generate Backup zip for the production files.</br>
## Attributes
> [!NOTE]
> All the attributes are entered in the Schematic Editor, make sure to update your PCB [**F8**] with the changes made to the schematic before generating a new set of production files, otherwise your changes won't be reflected.
### ① Include Component Part Number in Production Files
Add an 'LCSC Part #'* field with the LCSC component part number to the symbol's fields property.
@@ -54,16 +61,19 @@ Add an 'LCSC Part #'* field with the LCSC component part number to the symbol's
<img src="https://github.com/bennymeg/JLC-Plugin-for-KiCad/blob/master/assets/mpn.png?raw=true" height=420>
#### Primary Fields*:
| 'LCSC Part #' | 'LCSC Part' | 'LCSC PN' | 'LCSC P/N' | 'LCSC Part No.' | 'JLCPCB Part #' | 'JLCPCB Part' | 'JLCPCB PN' | 'JLCPCB P/N' | 'JLCPCB Part No.' |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| 'LCSC Part #' | 'LCSC Part' | 'LCSC PN' | 'LCSC P/N' | 'LCSC Part No.' | 'LCSC Part Number' | 'JLCPCB Part #' | 'JLCPCB Part' | 'JLCPCB PN' | 'JLCPCB P/N' | 'JLCPCB Part No.' | 'JLCPCB Part Number' |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
_The fields will be query in the order denoted above._
_The fields will be queried in the order denoted above._
#### Fallback Fields*:
| 'LCSC' | 'JLC' | 'MPN' | 'Mpn' | 'mpn' |
| --- | --- | --- | --- | --- |
_The fields will be query in the order denoted above._
_The fields will be queried in the order denoted above._
Empty fields are skipped so, for example, a 'MPN' field with a value will be used if
all earlier fields are missing or empty.
---
@@ -87,7 +97,18 @@ If the JLC preview shows a footprint like this, enter a rotation offset of -90 t
<img src="https://github.com/bennymeg/JLC-Plugin-for-KiCad/blob/master/assets/rotation.png?raw=true" height=420>
As the rotation offset is entered in the Schematic Editor, make sure to update your PCB with the changes made to the schematic before generating a new set of production files, otherwise your changes won't be reflected.
Use following table to quickly find out to which coordinate enter the correction based on JLC arrows clicks - depending on footprint rotation in KiCad PCB Editor status bar:
|KiCad footprint deg | x | y|
|----|----|----|
|0 deg, Front | right arrow | up arrow |
|0 deg, Back | left arrow | down arrow |
|180 deg, Front | left arrow | down arrow |
|180 deg, Back | right arrow | up arrow |
|90 deg, Front or Back | up arrow | left arrow |
|-90 deg, Front or Back | down arrow | right arrow |
> [!TIP]
> Single arrow press in JLC is 0.0635mm (= 1/400in) shift.
#### Primary Fields*:
| 'FT Rotation Offset' |
@@ -104,24 +125,12 @@ _The fields will be queried in the order denoted above._
---
### ④ Offset Component Position
The position of components in KiCad Footprints does not always match the orientation in the JLC library because KiCad and JLCPCB used different variation of the same standard. To the exception cases: add an 'FT Position Offset'* field with an comma separated x,y position offset to correct it.
Use following table to quickly find out to which coordinate enter the correction based on JLC arrows clicks - depending on footprint rotation in KiCad PCB Editor status bar:
|KiCad footprint deg | x | y|
|----|----|----|
|0 deg, Front | right arrow | up arrow |
|0 deg, Back | left arrow | down arrow |
|180 deg, Front | left arrow | down arrow |
|180 deg, Back | right arrow | up arrow |
|90 deg, Front or Back | up arrow | left arrow |
|-90 deg, Front or Back | down arrow | right arrow |
For custom angles it's best to place also a temporary straight symbol to perform alignment.
Single arrow press in JLC is 0.0635mm (= 1/400in) shift.
The position of components in KiCad Footprints does not always match the orientation in the JLC library because KiCad and JLCPCB used different variation of the same standard. To the exception cases: add an 'FT Position Offset'* field with an comma separated x,y position offset to correct it.
<img src="https://github.com/bennymeg/JLC-Plugin-for-KiCad/blob/master/assets/position.png?raw=true" height=420>
As the position offset is entered in the Schematic Editor, make sure to update your PCB with the changes made to the schematic before generating a new set of production files, otherwise your changes won't be reflected.
> [!TIP]
> Single arrow press in JLC equals to 0.0635mm (= 1/400in) shift.
#### Primary Fields*:
| 'FT Position Offset' |
@@ -136,7 +145,7 @@ _The fields will be queried in the order denoted above._
_The fields will be queried in the order denoted above._
### ⑤ Override Component Origin
The Fabrication Toolkit reports the position of each component based on an automatically selected point of reference. This default behavior can be overridden by adding an 'FT Origin'* field to the component.
The Fabrication Toolkit reports the position of each component based on an automatically selected point of reference. This default behavior can be overridden by adding an 'FT Origin'* field to the component.
#### Primary Fields*:
| 'FT Origin' |
@@ -186,7 +195,7 @@ python3 -m plugins.cli -h
usage: Fabrication Toolkit [-h] --path PATH [--additionalLayers LAYERS] [--user1VCut] [--user2AltVCut]
[--autoTranslate] [--autoFill] [--excludeDNP] [--allActiveLayers] [--archiveName NAME]
[--openBrowser]
[--openBrowser] [--noBackup]
Generates JLCPCB production files from a KiCAD board file
@@ -205,9 +214,12 @@ options:
--archiveName NAME, -aN NAME
Name of the generated archives
--openBrowser, -b Open web browser with directory file overview after generation
--noBackup, -nB Do not create a backup of the project before generation
```
## Author
Benny Megidish
<iframe src="https://github.com/sponsors/electron-rare/card" title="Sponsor electron-rare" height="225" width="600" style="border: 0;"></iframe>
+225
View File
@@ -0,0 +1,225 @@
<img src="https://github.com/bennymeg/JLC-Plugin-for-KiCad/blob/master/assets/logo.svg?raw=true"
style="display:block margin-left: auto; margin-right: auto;" alt="JLC PCB Plug-in for KiCad">
<div align="center">
| **JLC PCB Plug-in for KiCad** |
|:-----:|
[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/bennymeg)
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/bennymeg/fabrication-toolkit/total)
</div>
## Features
1. Generates gerber files in correct format for production
2. Generates BOM file in correct format for production
3. Generates Pick and Place file in correct format for assembly
4. Generates IPC netlist file
## Installation
### Official Installation
Fabrication Toolkit is distributed with the official releases of KiCad 6+. Open the "Plugin and Content Manager" from the KiCad main menu and install the "<ins>Fabrication Toolkit</ins>" plugin from the selection list.
<img src="https://github.com/bennymeg/JLC-Plugin-for-KiCad/blob/master/assets/manager.png?raw=true" height=275>
### Manual installation
Download the [latest release](https://github.com/bennymeg/JLC-Plugin-for-KiCad/releases) ZIP file. Open the "Plugin and Content Manager" from the KiCads main window and install the ZIP file via "Install from File".
## Usage
Click on the Fabrication Toolkit <img src="https://github.com/bennymeg/JLC-Plugin-for-KiCad/blob/master/resources/icon.png?raw=true" style="margin-bottom: 8px;" alt="Logo" height=24> button on the top tool box inside KiCad pcb editor (pcbnew), choose the required options and click on 'Generate'.
> [!IMPORTANT]
> Ensure your board is synchronized before invoking this addon [**F8**].
## Options
Options can be set in the dialog that appears when the plugin is invoked. They are saved in a file called `fabrication-toolkit-options.json` in the project directory so that they are remembered between invocations of the plugin.
<img src="https://github.com/bennymeg/JLC-Plugin-for-KiCad/blob/master/assets/options.png?raw=true" height=275>
__Archive name__: Name of the archive file to be generated. Can include text variables, such as e.g. `${TITLE}_${REVISION}`</br>
__Additional layers__: Comma-separated list of additional layers to include in the gerber archive.</br>
__Plot all active layers__: Whether to include all layers, instead of just the layers required by JLCPCB.</br>
__Set User.1 as V-Cut layer__: Merge User.1 layer with the Edge-Cut layer in production.</br>
__Use User.2 for an alternative Edge-Cut layer__: Use the User.2 instead of the Edge-Cut layer for the board outline in production.
This is useful if you need process edges or panelization during production but still want to keep the individual outline for prototyping, 3D model exports, or similar purposes.</br>
__Apply automatic translations__: Apply known translation fixes for common components.</br>
__Apply automatic fill for all zones__: Refill all zones before generation production files.</br>
__Exclude DNP components from BOM__: Exclude components the had been set a DNP from th BOM.</br>
__Generate Backups__: Generate Backup zip for the production files.</br>
## Attributes
> [!NOTE]
> All the attributes are entered in the Schematic Editor, make sure to update your PCB [**F8**] with the changes made to the schematic before generating a new set of production files, otherwise your changes won't be reflected.
### ① Include Component Part Number in Production Files
Add an 'LCSC Part #'* field with the LCSC component part number to the symbol's fields property.
<img src="https://github.com/bennymeg/JLC-Plugin-for-KiCad/blob/master/assets/mpn.png?raw=true" height=420>
#### Primary Fields*:
| 'LCSC Part #' | 'LCSC Part' | 'LCSC PN' | 'LCSC P/N' | 'LCSC Part No.' | 'LCSC Part Number' | 'JLCPCB Part #' | 'JLCPCB Part' | 'JLCPCB PN' | 'JLCPCB P/N' | 'JLCPCB Part No.' | 'JLCPCB Part Number' |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
_The fields will be queried in the order denoted above._
#### Fallback Fields*:
| 'LCSC' | 'JLC' | 'MPN' | 'Mpn' | 'mpn' |
| --- | --- | --- | --- | --- |
_The fields will be queried in the order denoted above._
Empty fields are skipped so, for example, a 'MPN' field with a value will be used if
all earlier fields are missing or empty.
---
### ② Ignore Footprint in Production Files
Select 'Exclude from board' or 'Exclude from BOM' in the symbol's attributes property in order to ignore the footprint from the relevant file.
<img src="https://github.com/bennymeg/JLC-Plugin-for-KiCad/blob/master/assets/attributes.png?raw=true" height=420>
Select 'Exclude from position files' or 'Exclude from BOM' in the footprint's fabrication attributes property in order to ignore the footprint from the relevant file.
<img src="https://github.com/bennymeg/JLC-Plugin-for-KiCad/blob/master/assets/fabrication.png?raw=true" height=505>
---
### ③ Offset Component Rotation
The rotation of components in KiCad Footprints does not always match the orientation in the JLC library because KiCad and JLC PCB used different variation of the same standard. Most of the rotations may be corrected by the `rotations.cf` definitions. To the exception cases: add an 'FT Rotation Offset'* field - with positive values indicating counter-clockwise orientation offset in degrees.
<img src="https://github.com/bennymeg/JLC-Plugin-for-KiCad/blob/master/assets/rotation-jlc.png?raw=true" height=164>
If the JLC preview shows a footprint like this, enter a rotation offset of -90 to rotate pin 1 to the lower right corner.
<img src="https://github.com/bennymeg/JLC-Plugin-for-KiCad/blob/master/assets/rotation.png?raw=true" height=420>
Use following table to quickly find out to which coordinate enter the correction based on JLC arrows clicks - depending on footprint rotation in KiCad PCB Editor status bar:
|KiCad footprint deg | x | y|
|----|----|----|
|0 deg, Front | right arrow | up arrow |
|0 deg, Back | left arrow | down arrow |
|180 deg, Front | left arrow | down arrow |
|180 deg, Back | right arrow | up arrow |
|90 deg, Front or Back | up arrow | left arrow |
|-90 deg, Front or Back | down arrow | right arrow |
> [!TIP]
> Single arrow press in JLC is 0.0635mm (= 1/400in) shift.
#### Primary Fields*:
| 'FT Rotation Offset' |
| --- |
_The fields will be queried in the order denoted above._
#### Fallback Fields*:
| 'Rotation Offset' | 'RotOffset' |
| --- | --- |
_The fields will be queried in the order denoted above._
---
### ④ Offset Component Position
The position of components in KiCad Footprints does not always match the orientation in the JLC library because KiCad and JLCPCB used different variation of the same standard. To the exception cases: add an 'FT Position Offset'* field with an comma separated x,y position offset to correct it.
<img src="https://github.com/bennymeg/JLC-Plugin-for-KiCad/blob/master/assets/position.png?raw=true" height=420>
> [!TIP]
> Single arrow press in JLC equals to 0.0635mm (= 1/400in) shift.
#### Primary Fields*:
| 'FT Position Offset' |
| --- |
_The fields will be queried in the order denoted above._
#### Fallback Fields*:
| 'Position Offset' | 'PosOffset' |
| --- | --- |
_The fields will be queried in the order denoted above._
### ⑤ Override Component Origin
The Fabrication Toolkit reports the position of each component based on an automatically selected point of reference. This default behavior can be overridden by adding an 'FT Origin'* field to the component.
#### Primary Fields*:
| 'FT Origin' |
| --- |
_The fields will be queried in the order denoted above._
#### Fallback Fields*:
| 'Origin' |
| --- |
The **Origin** field supports the following values:
- `Anchor` - Uses the footprint's anchor point, which can be modified in KiCad's footprint editor.
- `Center` - Uses the center of the bounding box formed by the footprint's pads.
### ⑥ Override Component Layer
Some footprints may have their components defined on the opposite layer to there actual footprints. In these instances you can override mount side by adding an 'FT Layer Override'* field to the component.
The **Layer Override** field supports the following values:
- `top`, `t` - Override footprint layer to the top.
- `bottom`, `b` - Override footprint layer to the bottom.
#### Primary Fields*:
| 'FT Layer Override' |
| --- |
_The fields will be queried in the order denoted above._
#### Fallback Fields*:
| 'Layer Override' | 'LayerOverride' |
| --- | --- |
_The fields will be queried in the order denoted above._
## CLI
The plugin can also be used via the linux command line. This can be particularly useful if you need to embed the plugin into an automation pipeline or environment.
The plugin can be called with the command below:
```
python3 -m plugins.cli -p /myProject/myBoard.kicad_pcb
```
All the options from the GUI are also available via the cli interface:
```
python3 -m plugins.cli -h
usage: Fabrication Toolkit [-h] --path PATH [--additionalLayers LAYERS] [--user1VCut] [--user2AltVCut]
[--autoTranslate] [--autoFill] [--excludeDNP] [--allActiveLayers] [--archiveName NAME]
[--openBrowser] [--noBackup]
Generates JLCPCB production files from a KiCAD board file
options:
-h, --help show this help message and exit
--path PATH, -p PATH Path to KiCAD board file
--additionalLayers LAYERS, -aL LAYERS
Additional layers(comma-separated)
--user1VCut, -u1 Set User.1 as V-Cut layer
--user2AltVCut, -u2 Use User.2 for alternative Edge-Cut layer
--autoTranslate, -t Apply automatic position/rotation translations
--autoFill, -f Apply automatic fill for all zones
--excludeDNP, -e Exclude DNP components from BOM
--allActiveLayers, -aaL
Export all active layers instead of only commonly used ones
--archiveName NAME, -aN NAME
Name of the generated archives
--openBrowser, -b Open web browser with directory file overview after generation
--noBackup, -nB Do not create a backup of the project before generation
```
## Author
Benny Megidish
<iframe src="https://github.com/sponsors/electron-rare/card" title="Sponsor electron-rare" height="225" width="600" style="border: 0;"></iframe>
Binary file not shown.

Before

Width:  |  Height:  |  Size: 248 KiB

After

Width:  |  Height:  |  Size: 284 KiB

+1 -1
View File
@@ -30,7 +30,7 @@
],
"versions": [
{
"version": "5.1.0",
"version": "5.2.0",
"status": "stable",
"kicad_version": "6.00"
}
+8 -4
View File
@@ -2,7 +2,7 @@ import argparse as ap
from .thread import ProcessThread
from .options import *
if __name__ == '__main__':
parser = ap.ArgumentParser(prog="Fabrication Toolkit",
@@ -11,13 +11,15 @@ if __name__ == '__main__':
parser.add_argument("--path", "-p", type=str, help="Path to KiCAD board file", required=True)
parser.add_argument("--additionalLayers", "-aL", type=str, help="Additional layers(comma-separated)", metavar="LAYERS")
parser.add_argument("--user1VCut", "-u1", action="store_true", help="Set User.1 as V-Cut layer")
parser.add_argument("--user2AltVCut", "-u2", action="store_true", help="Use User.2 for alternative Edge-Cut layer")
parser.add_argument("--user2AltVCut", "-u2", action="store_true", help="Set User.2 as alternative Edge-Cut layer")
parser.add_argument("--autoTranslate", "-t", action="store_true", help="Apply automatic position/rotation translations")
parser.add_argument("--autoFill", "-f", action="store_true", help="Apply automatic fill for all zones")
parser.add_argument("--excludeDNP", "-e", action="store_true", help="Exclude DNP components from BOM")
parser.add_argument("--allActiveLayers", "-aaL",action="store_true", help="Export all active layers instead of only commonly used ones")
parser.add_argument("--archiveName", "-aN", type=str, help="Name of the generated archives", metavar="NAME")
parser.add_argument("--openBrowser", "-b", action="store_true", help="Open webbrowser with directory file overview after generation")
parser.add_argument("--nonInteractive", "-nI" ,action="store_true", help="Run in non-Interactive mode. Useful in CI/CD environment.")
parser.add_argument("--noBackup", "-nB", action="store_true", help="Do not create backup files")
args = parser.parse_args()
options = dict()
@@ -29,10 +31,12 @@ if __name__ == '__main__':
options[ALL_ACTIVE_LAYERS_OPT] = args.allActiveLayers
options[ARCHIVE_NAME] = args.archiveName
options[EXTRA_LAYERS] = args.additionalLayers
options[BACKUP_OPT] = not args.noBackup
openBrowser = args.openBrowser
nonInteractive = args.nonInteractive
path = args.path
ProcessThread(wx=None, cli=path, options=options, openBrowser=openBrowser)
ProcessThread(wx=None, cli=path, options=options, openBrowser=openBrowser, nonInteractive=nonInteractive)
+3 -1
View File
@@ -5,5 +5,7 @@ OUTPUT_NAME_OPT = "OUTPUT NAME"
EXTEND_EDGE_CUT_OPT = "EXTEND_EDGE_CUT"
ALTERNATIVE_EDGE_CUT_OPT = "ALTERNATIVE_EDGE_CUT"
ALL_ACTIVE_LAYERS_OPT = "ALL_ACTIVE_LAYERS"
OPEN_BROWSER_OPT = "OPEN BROWSER"
ARCHIVE_NAME = "ARCHIVE_NAME"
EXTRA_LAYERS = "EXTRA_LAYERS"
EXTRA_LAYERS = "EXTRA_LAYERS"
BACKUP_OPT = "BACKUP_OPT"
+19 -8
View File
@@ -1,10 +1,10 @@
import os
import wx
import pcbnew # type: ignore
import pcbnew # type: ignore
from .thread import ProcessThread
from .events import StatusEvent
from .options import AUTO_FILL_OPT, AUTO_TRANSLATE_OPT, EXCLUDE_DNP_OPT, EXTEND_EDGE_CUT_OPT, ALTERNATIVE_EDGE_CUT_OPT, EXTRA_LAYERS, ALL_ACTIVE_LAYERS_OPT, ARCHIVE_NAME
from .options import AUTO_FILL_OPT, AUTO_TRANSLATE_OPT, EXCLUDE_DNP_OPT, EXTEND_EDGE_CUT_OPT, ALTERNATIVE_EDGE_CUT_OPT, EXTRA_LAYERS, ALL_ACTIVE_LAYERS_OPT, ARCHIVE_NAME, OPEN_BROWSER_OPT, BACKUP_OPT
from .utils import load_user_options, save_user_options, get_layer_names
@@ -19,7 +19,7 @@ class KiCadToJLCForm(wx.Frame):
pos=wx.DefaultPosition,
size=wx.DefaultSize,
style=wx.DEFAULT_DIALOG_STYLE)
# self.app = wx.PySimpleApp()
icon = wx.Icon(os.path.join(os.path.dirname(__file__), 'icon.png'))
self.SetIcon(icon)
@@ -35,7 +35,9 @@ class KiCadToJLCForm(wx.Frame):
ALTERNATIVE_EDGE_CUT_OPT: False,
AUTO_TRANSLATE_OPT: True,
AUTO_FILL_OPT: True,
EXCLUDE_DNP_OPT: False
EXCLUDE_DNP_OPT: False,
OPEN_BROWSER_OPT: True,
BACKUP_OPT: True,
})
self.mOptionsLabel = wx.StaticText(self, label='Options:')
@@ -55,14 +57,18 @@ class KiCadToJLCForm(wx.Frame):
self.mAllActiveLayersCheckbox.SetValue(userOptions[ALL_ACTIVE_LAYERS_OPT])
self.mExtendEdgeCutsCheckbox = wx.CheckBox(self, label='Set User.1 as V-Cut layer')
self.mExtendEdgeCutsCheckbox.SetValue(userOptions[EXTEND_EDGE_CUT_OPT])
self.mAlternativeEdgeCutsCheckbox = wx.CheckBox(self, label='Use User.2 for alternative Edge-Cut layer')
self.mAlternativeEdgeCutsCheckbox = wx.CheckBox(self, label='Set User.2 as alternative Edge-Cut layer')
self.mAlternativeEdgeCutsCheckbox.SetValue(userOptions[ALTERNATIVE_EDGE_CUT_OPT])
self.mAutomaticTranslationCheckbox = wx.CheckBox(self, label='Apply automatic translations')
self.mAutomaticTranslationCheckbox = wx.CheckBox(self, label='Apply automatic component translations')
self.mAutomaticTranslationCheckbox.SetValue(userOptions[AUTO_TRANSLATE_OPT])
self.mAutomaticFillCheckbox = wx.CheckBox(self, label='Apply automatic fill for all zones')
self.mAutomaticFillCheckbox.SetValue(userOptions[AUTO_FILL_OPT])
self.mExcludeDnpCheckbox = wx.CheckBox(self, label='Exclude DNP components from BOM')
self.mExcludeDnpCheckbox.SetValue(userOptions[EXCLUDE_DNP_OPT])
self.mOpenBrowserCheckbox = wx.CheckBox(self, label='Open browser after generation')
self.mOpenBrowserCheckbox.SetValue(userOptions[OPEN_BROWSER_OPT])
self.mBackupCheckbox = wx.CheckBox(self, label='Generate backup files')
self.mBackupCheckbox.SetValue(userOptions[BACKUP_OPT])
self.mGaugeStatus = wx.Gauge(
self, wx.ID_ANY, 100, wx.DefaultPosition, wx.Size(600, 20), wx.GA_HORIZONTAL)
@@ -84,6 +90,8 @@ class KiCadToJLCForm(wx.Frame):
boxSizer.Add(self.mAutomaticTranslationCheckbox, 0, wx.ALL, 5)
boxSizer.Add(self.mAutomaticFillCheckbox, 0, wx.ALL, 5)
boxSizer.Add(self.mExcludeDnpCheckbox, 0, wx.ALL, 5)
boxSizer.Add(self.mOpenBrowserCheckbox, 0, wx.ALL, 5)
boxSizer.Add(self.mBackupCheckbox, 0, wx.ALL, 5)
boxSizer.Add(self.mGaugeStatus, 0, wx.ALL, 5)
boxSizer.Add(self.mGenerateButton, 0, wx.ALL, 5)
@@ -103,7 +111,6 @@ class KiCadToJLCForm(wx.Frame):
else:
event.Skip()
def onGenerateButtonClick(self, event):
options = dict()
options[ARCHIVE_NAME] = self.mArchiveNameControl.GetValue()
@@ -114,6 +121,8 @@ class KiCadToJLCForm(wx.Frame):
options[AUTO_TRANSLATE_OPT] = self.mAutomaticTranslationCheckbox.GetValue()
options[AUTO_FILL_OPT] = self.mAutomaticFillCheckbox.GetValue()
options[EXCLUDE_DNP_OPT] = self.mExcludeDnpCheckbox.GetValue()
options[OPEN_BROWSER_OPT] = self.mOpenBrowserCheckbox.GetValue()
options[BACKUP_OPT] = self.mBackupCheckbox.GetValue()
save_user_options(options)
@@ -126,6 +135,8 @@ class KiCadToJLCForm(wx.Frame):
self.mAutomaticTranslationCheckbox.Hide()
self.mAutomaticFillCheckbox.Hide()
self.mExcludeDnpCheckbox.Hide()
self.mOpenBrowserCheckbox.Hide()
self.mBackupCheckbox.Hide()
self.mGenerateButton.Hide()
self.mGaugeStatus.Show()
@@ -133,7 +144,7 @@ class KiCadToJLCForm(wx.Frame):
self.SetTitle('Fabrication Toolkit (Processing...)')
StatusEvent.invoke(self, self.updateDisplay)
ProcessThread(self, options)
ProcessThread(self, options, openBrowser=options[OPEN_BROWSER_OPT])
def updateDisplay(self, status):
if status.data == -1:
+5 -4
View File
@@ -47,6 +47,7 @@ class ProcessManager:
def generate_gerber(self, temp_dir, extra_layers, extend_edge_cuts, alternative_edge_cuts, all_active_layers):
'''Generate the Gerber files.'''
original_settings = self.board.GetDesignSettings()
settings = self.board.GetDesignSettings()
settings.m_SolderMaskMargin = 50000
settings.m_SolderMaskToCopperClearance = 5000
@@ -98,6 +99,7 @@ class ProcessManager:
plot_controller.PlotLayer()
plot_controller.ClosePlot()
settings = original_settings
def generate_drills(self, temp_dir):
'''Generate the drill file.'''
@@ -345,7 +347,6 @@ class ProcessManager:
rowNum = rowNum + 1
# First row is header row, skip.
if rowNum == 1:
skipFirst = False
continue
# If there was too many fields, throw an exception.
@@ -458,7 +459,7 @@ class ProcessManager:
def _get_mpn_from_footprint(self, footprint) -> str:
''''Get the MPN/LCSC stock code from standard symbol fields.'''
supplier_names = ['LCSC', 'JLCPCB']
pn_abbrevs = ['Part #', 'Part', 'PN', 'P/N', 'Part No.']
pn_abbrevs = ['Part #', 'Part', 'PN', 'P/N', 'Part No.', 'Part Number']
keys = [(sn + " " + abr) for sn in supplier_names for abr in pn_abbrevs]
fallback_keys = ['LCSC', 'JLC', 'MPN', 'Mpn', 'mpn']
@@ -466,7 +467,7 @@ class ProcessManager:
return 'DNP'
for key in keys + fallback_keys:
if footprint_has_field(footprint, key):
if footprint_has_field(footprint, key) and '' != footprint_get_field(footprint, key):
return footprint_get_field(footprint, key)
def _get_layer_override_from_footprint(self, footprint) -> str:
@@ -530,7 +531,7 @@ class ProcessManager:
try:
offset = offset.split(",")
return (float(offset[0]), float(offset[1]))
except Exception as e:
except Exception:
raise RuntimeError("Position offset of {} is not a valid pair of numbers".format(footprint.GetReference()))
def _get_origin_from_footprint(self, footprint) -> float:
+18 -7
View File
@@ -15,10 +15,10 @@ from .utils import print_cli_progress_bar
class ProcessThread(Thread):
def __init__(self, wx, options, cli = None, openBrowser = True):
def __init__(self, wx, options, cli = None, openBrowser = True, nonInteractive = False):
Thread.__init__(self)
# prevent use of cli and grapgical mode at the same time
# prevent use of cli and graphical mode at the same time
if (wx is None and cli is None) or (wx is not None and cli is not None):
logging.error("Specify either graphical or cli use!")
return
@@ -37,6 +37,7 @@ class ProcessThread(Thread):
self.cli = cli
self.options = options
self.openBrowser = openBrowser
self.nonInteractive = nonInteractive
self.start()
def expandTextVariables(self, string):
@@ -160,10 +161,19 @@ class ProcessThread(Thread):
gerberArchiveName = ProcessManager.normalize_filename("_".join((baseName.strip() + '.zip').split()))
os.rename(temp_file, os.path.join(temp_dir, gerberArchiveName))
timestamp = datetime.datetime.now().strftime('%Y-%m-%d %H-%M-%S')
backup_name = ProcessManager.normalize_filename("_".join(("{} {}".format(baseName, timestamp).strip()).split()))
shutil.make_archive(os.path.join(output_path, 'backups', backup_name), 'zip', temp_dir)
if self.options[ARCHIVE_NAME]:
if os.path.exists(os.path.join(temp_dir, designatorsFileName)):
os.rename(os.path.join(temp_dir, designatorsFileName), os.path.join(temp_dir, ProcessManager.normalize_filename("_".join((baseName.strip() + '_designators.csv').split()))))
if os.path.exists(os.path.join(temp_dir, placementFileName)):
os.rename(os.path.join(temp_dir, placementFileName), os.path.join(temp_dir, ProcessManager.normalize_filename("_".join((baseName.strip() + '_positions.csv').split()))))
if os.path.exists(os.path.join(temp_dir, bomFileName)):
os.rename(os.path.join(temp_dir, bomFileName), os.path.join(temp_dir, ProcessManager.normalize_filename("_".join((baseName.strip() + '_bom.csv').split()))))
# Make a backup as long as the BACKUP_OPT flag is set.
if not self.options[BACKUP_OPT]:
timestamp = datetime.datetime.now().strftime('%Y-%m-%d %H-%M-%S')
backup_name = ProcessManager.normalize_filename("_".join(("{} {}".format(baseName, timestamp).strip()).split()))
shutil.make_archive(os.path.join(output_path, 'backups', backup_name), 'zip', temp_dir)
# copy to & open output dir
try:
@@ -171,7 +181,7 @@ class ProcessThread(Thread):
if self.openBrowser:
webbrowser.open("file://%s" % (output_path))
shutil.rmtree(temp_dir)
except Exception as e:
except Exception:
if self.openBrowser:
webbrowser.open("file://%s" % (temp_dir))
@@ -182,6 +192,7 @@ class ProcessThread(Thread):
def progress(self, percent):
if self.wx is None:
print_cli_progress_bar(percent, prefix = 'Progress:', suffix = 'Complete', length = 50)
if not self.nonInteractive:
print_cli_progress_bar(percent, prefix = 'Progress:', suffix = 'Complete', length = 50)
else:
wx.PostEvent(self.wx, StatusEvent(percent))