chore: bump version

This is because of the way Ultra Librarian setup the names with colon

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -17,7 +17,15 @@ body:
       What version of Fabrication Toolkit are you using?
 
       Note: Please only report issues for currently supported versions of Fabrication Toolkit.
-    placeholder: 4.0.0
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: KiCad Version
+    description: |
+      What version of KiCad are you using?
+
+      Note: Please only report issues for currently supported versions of KiCad.
   validations:
     required: true
 - type: dropdown

.gitignore

@@ -1,2 +1,4 @@
 .venv
-dist/
+dist/
+.DS_Store
+*.pyc

.vscode/settings.json

@@ -1,14 +1,22 @@
 {
     "cSpell.words": [
+        "bennymeg",
         "Colour",
         "csvfile",
         "Drilland",
+        "Elec",
         "EXCELLON",
         "FPID",
+        "gerbers",
+        "HTSSOP",
         "JLCPCB",
+        "kicad",
         "LCSC",
+        "LQFP",
         "LSEQ",
+        "MSOP",
         "netlist",
+        "panelization",
         "pcbnew",
         "Plotfile",
         "Protel",
@@ -16,6 +24,18 @@
         "restkey",
         "restval",
         "rsin",
-        "Soldermask"
+        "SOIC",
+        "Soldermask",
+        "SPST",
+        "SSOP",
+        "TDSON",
+        "TQFP",
+        "TSOT",
+        "TSSOP",
+        "UDFN",
+        "USON",
+        "venv",
+        "VSON",
+        "VSSOP"
     ]
 }

README.md

@@ -27,9 +27,9 @@ 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="magin-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).
 
-**⊛** Ensure your board is syncronized before invoking this addon [**F8**].
+**⊛** 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>
 
@@ -39,7 +39,9 @@ Options can be set in the dialog that appears when the plugin is invoked. They a
 
 <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>
@@ -52,14 +54,14 @@ 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 #' | 'JLCPCB Part #' |
-| --- | --- |
+| 'LCSC Part #' | 'LCSC Part' | 'LCSC PN' | 'LCSC P/N' | 'LCSC Part No.' | 'JLCPCB Part #' | 'JLCPCB Part' | 'JLCPCB PN' | 'JLCPCB P/N' | 'JLCPCB Part No.' |
+| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
 
 _The fields will be query in the order denoted above._
 
 #### Fallback Fields*:
-| 'JLC Part' | 'LCSC Part' | 'LCSC' | 'JLC' | 'MPN' | 'Mpn' | 'mpn' |
-| --- | --- | --- | --- | --- | --- | --- |
+| 'LCSC' | 'JLC' | 'MPN' | 'Mpn' | 'mpn' |
+| --- | --- | --- | --- | --- |
 
 _The fields will be query in the order denoted above._
 
@@ -77,7 +79,7 @@ Select 'Exclude from position files' or 'Exclude from BOM' in the footprint's fa
 ---
 
 ### ③ 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 'JLCPCB Rotation Offset' field - with positive values indicating counter-clockwise orientation offset in degrees.
+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>
 
@@ -88,13 +90,13 @@ If the JLC preview shows a footprint like this, enter a rotation offset of -90 t
 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.
 
 #### Primary Fields*:
-| 'JLCPCB Rotation Offset' |
+| 'FT Rotation Offset' |
 | --- |
 
 _The fields will be queried in the order denoted above._
 
 #### Fallback Fields*:
-| 'JlcRotOffset' | 'JLCRotOffset' |
+| 'Rotation Offset' | 'RotOffset' |
 | --- | --- |
 
 _The fields will be queried in the order denoted above._
@@ -102,17 +104,17 @@ _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 JLCPB used different variation of the same standard. To the exception cases: add an 'JLCPCB Position Offset' field with an comma separated x,y position offset to correct it. 
+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|
+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|
 |----|----|----|
-|0deg, Front | right arrow | up arrow |
-|0deg, Back | left arrow | down arrow |
-|180deg, Front | left arrow | down arrow |
-|180deg, Back | right arrow | up arrow |
-|90deg, Front or Back | up arrow | left arrow |
-|-90deg, Front or Back | down arrow | right arrow |
+|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.
@@ -122,35 +124,89 @@ Single arrow press in JLC is 0.0635mm (= 1/400in) shift.
 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.
 
 #### Primary Fields*:
-| 'JLCPCB Position Offset' |
+| 'FT Position Offset' |
 | --- |
 
 _The fields will be queried in the order denoted above._
 
 #### Fallback Fields*:
-| 'JlcPosOffset' | 'JLCPosOffset' |
+| 'Position Offset' | 'PosOffset' |
 | --- | --- |
 
 _The fields will be queried in the order denoted above._
 
-### ⑤ 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 using this field.
-
-Values can be `top`, `bottom`, `t` or `b`.
+### ⑤ 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*:
-| 'JLCPCB Layer Override' |
+| 'FT Origin' |
 | --- |
 
 _The fields will be queried in the order denoted above._
 
 #### Fallback Fields*:
-| 'JlcLayerOverride' | 'JLCLayerOverride' |
+| '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]
+
+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
+```
+
 
 ## Author
 

metadata.json

@@ -30,7 +30,7 @@
     ],
     "versions": [
         {
-            "version": "4.5.0",
+            "version": "5.1.0",
             "status": "stable",
             "kicad_version": "6.00"
         }

plugins/cli.py

@@ -0,0 +1,38 @@
+import argparse as ap
+
+from .thread import ProcessThread
+from .options import *
+   
+
+if __name__ == '__main__':
+    parser = ap.ArgumentParser(prog="Fabrication Toolkit",
+                            description="Generates JLCPCB production files from a KiCAD board file")
+
+    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("--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")
+    args = parser.parse_args()
+
+    options = dict()
+    options[AUTO_TRANSLATE_OPT] = args.autoTranslate
+    options[AUTO_FILL_OPT] = args.autoFill
+    options[EXCLUDE_DNP_OPT] = args.excludeDNP
+    options[EXTEND_EDGE_CUT_OPT] = args.user1VCut
+    options[ALTERNATIVE_EDGE_CUT_OPT] = args.user2AltVCut
+    options[ALL_ACTIVE_LAYERS_OPT] = args.allActiveLayers
+    options[ARCHIVE_NAME] = args.archiveName
+    options[EXTRA_LAYERS] = args.additionalLayers
+
+    openBrowser = args.openBrowser
+
+
+    path = args.path
+
+    ProcessThread(wx=None, cli=path, options=options, openBrowser=openBrowser)

plugins/config.py

@@ -10,4 +10,17 @@ gerberArchiveName = 'gerbers.zip'
 outputFolder = 'production'
 bomRowLimit = 200
 
-optionsFileName = 'fabrication-toolkit-options.json'
+optionsFileName = 'fabrication-toolkit-options.json'
+
+standardLayers = [ pcbnew.F_Cu, pcbnew.B_Cu,
+                   pcbnew.In1_Cu, pcbnew.In2_Cu, pcbnew.In3_Cu, pcbnew.In4_Cu, pcbnew.In5_Cu,
+                   pcbnew.In6_Cu, pcbnew.In7_Cu, pcbnew.In8_Cu, pcbnew.In9_Cu, pcbnew.In10_Cu,
+                   pcbnew.In11_Cu, pcbnew.In12_Cu, pcbnew.In13_Cu, pcbnew.In14_Cu, pcbnew.In15_Cu,
+                   pcbnew.In16_Cu, pcbnew.In17_Cu, pcbnew.In18_Cu, pcbnew.In19_Cu, pcbnew.In20_Cu,
+                   pcbnew.In21_Cu, pcbnew.In22_Cu, pcbnew.In23_Cu, pcbnew.In24_Cu, pcbnew.In25_Cu,
+                   pcbnew.In26_Cu, pcbnew.In27_Cu, pcbnew.In28_Cu, pcbnew.In29_Cu, pcbnew.In30_Cu,
+                   pcbnew.F_SilkS, pcbnew.B_SilkS,
+                   pcbnew.F_Mask, pcbnew.B_Mask,
+                   pcbnew.F_Paste, pcbnew.B_Paste,
+                   pcbnew.Edge_Cuts
+                   ]

plugins/options.py

@@ -4,4 +4,6 @@ EXCLUDE_DNP_OPT = "EXCLUDE DNP"
 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"
+ARCHIVE_NAME = "ARCHIVE_NAME"
 EXTRA_LAYERS = "EXTRA_LAYERS"

plugins/plugin.py

@@ -4,7 +4,7 @@ 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
+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 .utils import load_user_options, save_user_options, get_layer_names
 
 
@@ -29,6 +29,8 @@ class KiCadToJLCForm(wx.Frame):
 
         userOptions = load_user_options({
             EXTRA_LAYERS: "",
+            ALL_ACTIVE_LAYERS_OPT: False,
+            ARCHIVE_NAME: "",
             EXTEND_EDGE_CUT_OPT: False,
             ALTERNATIVE_EDGE_CUT_OPT: False,
             AUTO_TRANSLATE_OPT: True,
@@ -41,11 +43,16 @@ class KiCadToJLCForm(wx.Frame):
 
         layers = get_layer_names(pcbnew.GetBoard())
         self.mAdditionalLayersControl = wx.TextCtrl(self, size=wx.Size(600, 50))
-        self.mAdditionalLayersControl.Hint = "Additional layers (comma-separated)"
+        self.mAdditionalLayersControl.Hint = "Additional layers (comma-separated) [optional]"
         self.mAdditionalLayersControl.AutoComplete(layers)
         self.mAdditionalLayersControl.Enable()
         self.mAdditionalLayersControl.SetValue(userOptions[EXTRA_LAYERS])
-
+        self.mArchiveNameControl = wx.TextCtrl(self, size=wx.Size(600, 50))
+        self.mArchiveNameControl.Hint = "Archive name (e.g. ${TITLE}_${REVISION}) [optional]"
+        self.mArchiveNameControl.Enable()
+        self.mArchiveNameControl.SetValue(userOptions[ARCHIVE_NAME])
+        self.mAllActiveLayersCheckbox = wx.CheckBox(self, label='Plot all active layers')
+        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')
@@ -69,7 +76,9 @@ class KiCadToJLCForm(wx.Frame):
 
         boxSizer.Add(self.mOptionsLabel, 0, wx.ALL, 5)
         # boxSizer.Add(self.mOptionsSeparator, 0, wx.ALL, 5)
+        boxSizer.Add(self.mArchiveNameControl, 0, wx.ALL, 5)
         boxSizer.Add(self.mAdditionalLayersControl, 0, wx.ALL, 5)
+        boxSizer.Add(self.mAllActiveLayersCheckbox, 0, wx.ALL, 5)
         boxSizer.Add(self.mExtendEdgeCutsCheckbox, 0, wx.ALL, 5)
         boxSizer.Add(self.mAlternativeEdgeCutsCheckbox, 0, wx.ALL, 5)
         boxSizer.Add(self.mAutomaticTranslationCheckbox, 0, wx.ALL, 5)
@@ -84,10 +93,22 @@ class KiCadToJLCForm(wx.Frame):
 
         self.Centre(wx.BOTH)
 
+        # Bind the ESC key event to a handler
+        self.Bind(wx.EVT_CHAR_HOOK, self.onKey)
+
+    # Close the dialog when pressing the ESC key
+    def onKey(self, event):
+        if event.GetKeyCode() == wx.WXK_ESCAPE:
+            self.Close(True)
+        else:
+            event.Skip()
+
 
     def onGenerateButtonClick(self, event):
         options = dict()
+        options[ARCHIVE_NAME] = self.mArchiveNameControl.GetValue()
         options[EXTRA_LAYERS] = self.mAdditionalLayersControl.GetValue()
+        options[ALL_ACTIVE_LAYERS_OPT] = self.mAllActiveLayersCheckbox.GetValue()
         options[EXTEND_EDGE_CUT_OPT] = self.mExtendEdgeCutsCheckbox.GetValue()
         options[ALTERNATIVE_EDGE_CUT_OPT] = self.mAlternativeEdgeCutsCheckbox.GetValue()
         options[AUTO_TRANSLATE_OPT] = self.mAutomaticTranslationCheckbox.GetValue()
@@ -97,7 +118,9 @@ class KiCadToJLCForm(wx.Frame):
         save_user_options(options)
 
         self.mOptionsLabel.Hide()
+        self.mArchiveNameControl.Hide()
         self.mAdditionalLayersControl.Hide()
+        self.mAllActiveLayersCheckbox.Hide()
         self.mExtendEdgeCutsCheckbox.Hide()
         self.mAlternativeEdgeCutsCheckbox.Hide()
         self.mAutomaticTranslationCheckbox.Hide()

plugins/process.py

@@ -17,10 +17,13 @@ from .utils import footprint_has_field, footprint_get_field, get_plot_plan
 # Application definitions.
 from .config import *
 
-
 class ProcessManager:
-    def __init__(self):
-        self.board = pcbnew.GetBoard()
+    def __init__(self, board = None):
+        # if no board is already loaded by cli mode getBoard from kicad environment
+        if board is None:
+            self.board = pcbnew.GetBoard()
+        else:
+            self.board = board
         self.bom = []
         self.components = []
         self.__rotation_db = self.__read_rotation_db()
@@ -42,7 +45,7 @@ class ProcessManager:
         # Finally rebuild the connectivity db
         self.board.BuildConnectivity()
 
-    def generate_gerber(self, temp_dir, extra_layers, extend_edge_cuts, alternative_edge_cuts):
+    def generate_gerber(self, temp_dir, extra_layers, extend_edge_cuts, alternative_edge_cuts, all_active_layers):
         '''Generate the Gerber files.'''
         settings = self.board.GetDesignSettings()
         settings.m_SolderMaskMargin = 50000
@@ -64,7 +67,7 @@ class ProcessManager:
         plot_options.SetSubtractMaskFromSilk(True)
         plot_options.SetUseGerberX2format(False)
         plot_options.SetDrillMarksType(0)  # NO_DRILL_SHAPE
-        
+
         if hasattr(plot_options, "SetExcludeEdgeLayer"):
             plot_options.SetExcludeEdgeLayer(True)
 
@@ -74,9 +77,9 @@ class ProcessManager:
             extra_layers = []
 
         for layer_info in get_plot_plan(self.board):
-            if self.board.IsLayerEnabled(layer_info[1]) or layer_info[0] in extra_layers:
+            if (self.board.IsLayerEnabled(layer_info[1]) and (all_active_layers or layer_info[1] in standardLayers)) or layer_info[0] in extra_layers:
                 plot_controller.SetLayer(layer_info[1])
-                plot_controller.OpenPlotfile(layer_info[0], pcbnew.PLOT_FORMAT_GERBER, layer_info[2])
+                plot_controller.OpenPlotfile(layer_info[2], pcbnew.PLOT_FORMAT_GERBER, layer_info[2])
 
                 if layer_info[1] == pcbnew.Edge_Cuts and hasattr(plot_controller, 'PlotLayers') and (extend_edge_cuts or alternative_edge_cuts):
                     seq = pcbnew.LSEQ()
@@ -114,24 +117,46 @@ class ProcessManager:
         netlist_writer = pcbnew.IPC356D_WRITER(self.board)
         netlist_writer.Write(os.path.join(temp_dir, netlistFileName))
 
-    def _get_footprint_position(self, footprint):
-        """Calculate position based on center of bounding box."""
-        position = footprint.GetPosition()
-        attributes = footprint.GetAttributes()
+    def _get_footprint_rotation(self, footprint):
+        return footprint.GetOrientation().AsDegrees() if hasattr(footprint.GetOrientation(), 'AsDegrees') else footprint.GetOrientation() / 10.0
 
-        if attributes & pcbnew.FP_SMD:
+    def _get_footprint_position(self, footprint):
+        """Calculate position based on center of pads / bounding box."""
+        origin_type = self._get_origin_from_footprint(footprint)
+
+        footprint_rotation = self._get_footprint_rotation(footprint)
+        footprint_rotated = footprint_rotation % 90 != 0
+
+        # if the footprint is not rotated by a multiple of 90 degrees, the bounding boxes will be off, so we create a temporary copy that is rotated to 0
+        if footprint_rotated:
+            footprint = footprint.Duplicate()
+            footprint.SetOrientationDegrees(0)
+
+        if origin_type == 'Anchor':
             position = footprint.GetPosition()
-        elif attributes & pcbnew.FP_THROUGH_HOLE:
-            position = footprint.GetBoundingBox(False, False).GetCenter()
-        else:                                           # handle Unspecified footprint type
+        else: # if type_origin == 'Center' or anything else
             pads = footprint.Pads()
             if len(pads) > 0:
                 # get bounding box based on pads only to ignore non-copper layers, e.g. silkscreen
                 bbox = pads[0].GetBoundingBox()         # start with small bounding box
                 for pad in pads:
                     bbox.Merge(pad.GetBoundingBox())    # expand bounding box
-
                 position = bbox.GetCenter()
+            else:
+                position = footprint.GetPosition()      # if we have no pads we fallback to anchor
+
+        if footprint_rotated:
+            # now we determine the offset of the "true" position relative to the "KiCAD" position & apply the footprints rotation
+
+            raw_pos = footprint.GetPosition()
+            relative_position = (position[0] - raw_pos[0], position[1] - raw_pos[1])
+
+            rsin = math.sin(footprint_rotation / 180 * math.pi)
+            rcos = math.cos(footprint_rotation / 180 * math.pi)
+
+            relative_position = ( relative_position[0] * rcos + relative_position[1] * rsin, -relative_position[0] * rsin + relative_position[1] * rcos )
+
+            position = (raw_pos[0] + relative_position[0], raw_pos[1] + relative_position[1])
 
         return position
 
@@ -163,7 +188,14 @@ class ProcessManager:
             except AttributeError:
                 footprint_name = str(footprint.GetFPID().GetLibItemName())
 
-            layer = self._get_top_or_bottom_side_override_from_footprint(footprint)
+            # Get the library nickname when available
+            lib_nickname = None
+            try:
+                lib_nickname = str(footprint.GetFPID().GetLibNickname())
+            except AttributeError:
+                pass
+
+            layer = self._get_layer_override_from_footprint(footprint)
 
             # mount_type = {
             #     0: 'smt',
@@ -171,8 +203,8 @@ class ProcessManager:
             #     2: 'unspecified'
             # }.get(footprint.GetAttributes())
 
-            is_dnp = (footprint_has_field(footprint, 'dnp') 
-                      or (footprint.GetValue().upper() == 'DNP') 
+            is_dnp = (footprint_has_field(footprint, 'dnp')
+                      or (footprint.GetValue().upper() == 'DNP')
                       or getattr(footprint, 'IsDNP', bool)())
             skip_dnp = exclude_dnp and is_dnp
 
@@ -187,12 +219,16 @@ class ProcessManager:
                 position = self._get_footprint_position(footprint)
                 mid_x = (position[0] - self.board.GetDesignSettings().GetAuxOrigin()[0]) / 1000000.0
                 mid_y = (position[1] - self.board.GetDesignSettings().GetAuxOrigin()[1]) * -1.0 / 1000000.0
-                rotation = footprint.GetOrientation().AsDegrees() if hasattr(footprint.GetOrientation(), 'AsDegrees') else footprint.GetOrientation() / 10.0
-                rotation_offset_db = self._get_rotation_from_db(footprint_name) # internal database offset
-                rotation_offset_manual = self._get_rotation_offset_from_footprint(footprint) # explicated offset by the designer
+                rotation = self._get_footprint_rotation(footprint)
+                rotation_offset_db = self._get_rotation_from_db(footprint_name, lib_nickname) # Try with lib_nickname if available
+                rotation_offset_manual = self._get_rotation_offset_from_footprint(footprint)
 
                 # position offset needs to take rotation into account
                 pos_offset = self._get_position_offset_from_footprint(footprint)
+                if auto_translate:
+                    pos_offset_db = self._get_position_offset_from_db(footprint_name, lib_nickname) # Try with lib_nickname if available
+                    pos_offset = (pos_offset[0] + pos_offset_db[0], pos_offset[1] + pos_offset_db[1])
+
                 rsin = math.sin(rotation / 180 * math.pi)
                 rcos = math.cos(rotation / 180 * math.pi)
 
@@ -289,7 +325,7 @@ class ProcessManager:
                 os.remove(os.path.join(temp_dir, item))
 
         return temp_file
-    
+
     """ Private """
 
     def __read_rotation_db(self, filename: str = os.path.join(os.path.dirname(__file__), 'transformations.csv')) -> dict[str, float]:
@@ -347,14 +383,18 @@ class ProcessManager:
                     db[rowNum]['name'] = row['footprint']
                     db[rowNum]['rotation'] = rotation
                     db[rowNum]['x'] = delta_x
-                    db[rowNum]['y'] = delta_y 
+                    db[rowNum]['y'] = delta_y
 
         return db
 
-    def _get_rotation_from_db(self, footprint: str) -> float:
-        '''Get the rotation to be added from the database file.'''
-        # Look for regular expression math of the footprint name and not its root library.
+    def _get_rotation_from_db(self, footprint: str, lib_nickname: str = None) -> float:
+        '''Get the rotation to be added from the database file.
 
+        Args:
+            footprint: The footprint name
+            lib_nickname: The library nickname, if available
+        '''
+        # First try with the standard approach for backward compatibility
         for entry in self.__rotation_db.items():
             # If the expression in the DB contains a :, search for it literally.
             if (re.search(':', entry[1]['name'])):
@@ -372,13 +412,23 @@ class ProcessManager:
                 if (re.search(entry[1]['name'], check)):
                     return float(entry[1]['rotation'])
 
+        # If no match found and we have a library nickname, try matching against that
+        if lib_nickname:
+            for entry in self.__rotation_db.items():
+                if (re.search(entry[1]['name'], lib_nickname)):
+                    return float(entry[1]['rotation'])
+
         # Not found, no rotation.
         return 0.0
 
-    def _get_position_offset_from_db(self, footprint: str) -> Tuple[float, float]:
-        '''Get the rotation to be added from the database file.'''
-        # Look for regular expression math of the footprint name and not its root library.
+    def _get_position_offset_from_db(self, footprint: str, lib_nickname: str = None) -> Tuple[float, float]:
+        '''Get the position offset to be added from the database file.
 
+        Args:
+            footprint: The footprint name
+            lib_nickname: The library nickname, if available
+        '''
+        # First try with the standard approach for backward compatibility
         for entry in self.__rotation_db.items():
             # If the expression in the DB contains a :, search for it literally.
             if (re.search(':', entry[1]['name'])):
@@ -394,15 +444,23 @@ class ProcessManager:
                 else:
                     check = footprint_segments[1]
                 if (re.search(entry[1]['name'], check)):
-                    return ( float(entry[1]['x']), float(entry[1]['y']) )
+                    return (float(entry[1]['x']), float(entry[1]['y']))
+
+        # If no match found and we have a library nickname, try matching against that
+        if lib_nickname:
+            for entry in self.__rotation_db.items():
+                if (re.search(entry[1]['name'], lib_nickname)):
+                    return (float(entry[1]['x']), float(entry[1]['y']))
 
         # Not found, no delta.
         return (0.0, 0.0)
 
     def _get_mpn_from_footprint(self, footprint) -> str:
         ''''Get the MPN/LCSC stock code from standard symbol fields.'''
-        keys = ['LCSC Part #', 'JLCPCB Part #']
-        fallback_keys = ['LCSC Part', 'JLC Part', 'LCSC', 'JLC', 'MPN', 'Mpn', 'mpn']
+        supplier_names = ['LCSC', 'JLCPCB']
+        pn_abbrevs = ['Part #', 'Part', 'PN', 'P/N', 'Part No.']
+        keys = [(sn + " " + abr) for sn in supplier_names for abr in pn_abbrevs]
+        fallback_keys = ['LCSC', 'JLC', 'MPN', 'Mpn', 'mpn']
 
         if footprint_has_field(footprint, 'dnp'):
             return 'DNP'
@@ -411,9 +469,10 @@ class ProcessManager:
             if footprint_has_field(footprint, key):
                 return footprint_get_field(footprint, key)
 
-    def _get_top_or_bottom_side_override_from_footprint(self, footprint) -> str:
-        keys = ['JLCPCB Layer Override']
-        fallback_keys = ['JlcLayerOverride', 'JLCLayerOverride']
+    def _get_layer_override_from_footprint(self, footprint) -> str:
+        '''Get the layer override from standard symbol fields.'''
+        keys = ['FT Layer Override']
+        fallback_keys = ['Layer Override', 'LayerOverride']
 
         layer = {
             pcbnew.F_Cu: 'top',
@@ -423,19 +482,20 @@ class ProcessManager:
         for key in keys + fallback_keys:
             if footprint_has_field(footprint, key):
                 temp_layer = footprint_get_field(footprint, key)
-                if (temp_layer[0] == 'b' or temp_layer[0] == 'B'):
-                    layer = "bottom"
-                    break
-                elif (temp_layer[0] == 't' or temp_layer[0] == 'T'):
-                    layer = "top"
-                    break
+                if len(temp_layer) > 0:
+                    if (temp_layer[0] == 'b' or temp_layer[0] == 'B'):
+                        layer = "bottom"
+                        break
+                    elif (temp_layer[0] == 't' or temp_layer[0] == 'T'):
+                        layer = "top"
+                        break
 
         return layer
 
     def _get_rotation_offset_from_footprint(self, footprint) -> float:
-        '''Get the rotation from standard symbol fields.'''
-        keys = ['JLCPCB Rotation Offset']
-        fallback_keys = ['JlcRotOffset', 'JLCRotOffset']
+        '''Get the rotation offset from standard symbol fields.'''
+        keys = ['FT Rotation Offset']
+        fallback_keys = ['Rotation Offset', 'RotOffset']
 
         offset = ""
 
@@ -453,8 +513,9 @@ class ProcessManager:
                 raise RuntimeError("Rotation offset of {} is not a valid number".format(footprint.GetReference()))
 
     def _get_position_offset_from_footprint(self, footprint) -> Tuple[float, float]:
-        keys = ['JLCPCB Position Offset']
-        fallback_keys = ['JlcPosOffset', 'JLCPosOffset']
+        '''Get the position offset from standard symbol fields.'''
+        keys = ['FT Position Offset']
+        fallback_keys = ['Position Offset', 'PosOffset']
 
         offset = ""
 
@@ -472,6 +533,29 @@ class ProcessManager:
             except Exception as e:
                 raise RuntimeError("Position offset of {} is not a valid pair of numbers".format(footprint.GetReference()))
 
+    def _get_origin_from_footprint(self, footprint) -> float:
+        '''Get the origin from standard symbol fields.'''
+        keys = ['FT Origin']
+        fallback_keys = ['Origin']
+
+        attributes = footprint.GetAttributes()
+
+        # determine origin type by package type
+        if attributes & pcbnew.FP_SMD:
+            origin_type = 'Anchor'
+        else:
+            origin_type = 'Center'
+
+        for key in keys + fallback_keys:
+            if footprint_has_field(footprint, key):
+                origin_type_override = str(footprint_get_field(footprint, key)).strip().capitalize()
+
+                if origin_type_override in ['Anchor', 'Center']:
+                    origin_type = origin_type_override
+                break
+
+        return origin_type
+
     def _normalize_footprint_name(self, footprint) -> str:
         # replace footprint names of resistors, capacitors, inductors, diodes, LEDs, fuses etc, with the footprint size only
         pattern = re.compile(r'^(\w*_SMD:)?\w{1,4}_(\d+)_\d+Metric.*$')

plugins/thread.py

@@ -5,22 +5,64 @@ import shutil
 import tempfile
 import webbrowser
 import datetime
+import logging
 from threading import Thread
 from .events import StatusEvent
 from .process import ProcessManager
 from .config import *
 from .options import *
+from .utils import print_cli_progress_bar
 
 
 class ProcessThread(Thread):
-    def __init__(self, wx, options):
+    def __init__(self, wx, options, cli = None, openBrowser = True):
         Thread.__init__(self)
 
-        self.process_manager = ProcessManager()
+        # prevent use of cli and grapgical 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
+        
+        if cli is not None:
+            try:
+                self.board = pcbnew.LoadBoard(cli)
+            except Exception as e:
+                logging.error("Fabrication Toolkit - Error" + str(e))
+                return
+        else:
+            self.board = None
+            
+        self.process_manager = ProcessManager(self.board)
         self.wx = wx
+        self.cli = cli
         self.options = options
+        self.openBrowser = openBrowser
         self.start()
 
+    def expandTextVariables(self, string):
+        titleBlock = pcbnew.GetBoard().GetTitleBlock()
+        
+        titleBlockVars = {
+            "ISSUE_DATE": titleBlock.GetDate(),
+            "CURRENT_DATE": datetime.datetime.now().strftime('%Y-%m-%d'),
+            "REVISION": titleBlock.GetRevision(),
+            "TITLE": titleBlock.GetTitle(),
+            "COMPANY": titleBlock.GetCompany(),
+        }
+
+        for comment_index in range(9):
+            titleBlockVars[f"COMMENT{comment_index + 1}"] = titleBlock.GetComment(comment_index)
+
+        for var, val in titleBlockVars.items():
+            string = string.replace(f"${{{var}}}", val)
+
+        if (hasattr(self.process_manager.board, "GetProject") and hasattr(pcbnew, "ExpandTextVars")):
+            project = self.process_manager.board.GetProject()
+            string = pcbnew.ExpandTextVars(string, project)
+
+        return string
+
+
     def run(self):
         # initializing
         self.progress(0)
@@ -40,7 +82,8 @@ class ProcessThread(Thread):
 
             # generate gerber
             self.progress(20)
-            self.process_manager.generate_gerber(temp_dir_gerber, self.options[EXTRA_LAYERS], self.options[EXTEND_EDGE_CUT_OPT], self.options[ALTERNATIVE_EDGE_CUT_OPT])
+            self.process_manager.generate_gerber(temp_dir_gerber, self.options[EXTRA_LAYERS], self.options[EXTEND_EDGE_CUT_OPT],
+                                                 self.options[ALTERNATIVE_EDGE_CUT_OPT], self.options[ALL_ACTIVE_LAYERS_OPT])
 
             # generate drill file
             self.progress(30)
@@ -69,7 +112,10 @@ class ProcessThread(Thread):
             shutil.rmtree(temp_dir_gerber)
             temp_file = os.path.join(temp_dir, os.path.basename(temp_file))
         except Exception as e:
-            wx.MessageBox(str(e), "Fabrication Toolkit - Error", wx.OK | wx.ICON_ERROR)
+            if self.wx is None:
+                logging.error("Fabrication Toolkit - Error" + str(e))
+            else:
+                wx.MessageBox(str(e), "Fabrication Toolkit - Error", wx.OK | wx.ICON_ERROR)
             self.progress(-1)
             return
 
@@ -106,23 +152,36 @@ class ProcessThread(Thread):
             os.makedirs(output_path)
         
         # rename gerber archive
-        gerberArchiveName = ProcessManager.normalize_filename("_".join(("{} {}".format(title or filename, revision or '').strip() + '.zip').split()))
+        if self.options[ARCHIVE_NAME]:
+            baseName = self.expandTextVariables(self.options[ARCHIVE_NAME])
+        else:
+            baseName = "{} {}".format(title or filename, revision or '')
+
+        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(title or filename, revision or '', timestamp).strip()).split()))
+        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:
             shutil.copytree(temp_dir, output_path, dirs_exist_ok=True)
-            webbrowser.open("file://%s" % (output_path))
+            if self.openBrowser:
+                webbrowser.open("file://%s" % (output_path))
             shutil.rmtree(temp_dir)
-        except Exception as e: 
-            webbrowser.open("file://%s" % (temp_dir))
+        except Exception as e:
+            if self.openBrowser:
+                webbrowser.open("file://%s" % (temp_dir))
 
-        self.progress(-1)
+        if self.wx is None: 
+            self.progress(100)
+        else:
+            self.progress(-1)
 
     def progress(self, percent):
-        wx.PostEvent(self.wx, StatusEvent(percent))
+        if self.wx is None:
+            print_cli_progress_bar(percent, prefix = 'Progress:', suffix = 'Complete', length = 50)
+        else:
+            wx.PostEvent(self.wx, StatusEvent(percent))

plugins/utils.py

@@ -7,6 +7,9 @@ import wx
 def get_version():
     return float('.'.join(pcbnew.GetBuildVersion().split(".")[0:2]))  # e.g GetBuildVersion(): e.g. '7.99.0-3969-gc5ac2337e4'
 
+def is_v10(version = get_version()):
+    return version >= 9.99 and version < 10.99
+
 def is_v9(version = get_version()):
     return version >= 8.99 and version < 9.99
 
@@ -22,7 +25,9 @@ def is_v6(version = get_version()):
 def footprint_has_field(footprint, field_name):
     version = get_version()
     
-    if is_v8(version) or is_v9(version):
+    if is_v10(version):
+        return footprint.HasField(field_name)
+    elif is_v8(version) or is_v9(version):
         return footprint.HasFieldByName(field_name)
     else:
         return footprint.HasProperty(field_name)
@@ -30,7 +35,9 @@ def footprint_has_field(footprint, field_name):
 def footprint_get_field(footprint, field_name):
     version = get_version()
     
-    if is_v8(version) or is_v9(version):
+    if is_v10(version):
+        return footprint.GetField(field_name).GetText()
+    elif is_v8(version) or is_v9(version):
         return footprint.GetFieldByName(field_name).GetText()
     else:
         return footprint.GetProperty(field_name)
@@ -72,7 +79,30 @@ def get_plot_plan(board, active_only=True):
 
         layers.append((layer_std_name, i, layer_name))
     return layers
+
 def get_layer_names(board, active_only=True):
     """Returns a list of (active) layer names of the current board"""
     plotPlan = get_plot_plan(board, active_only)
-    return [layer_info[0] for layer_info in plotPlan]
+    return [layer_info[0] for layer_info in plotPlan]
+
+def print_cli_progress_bar(percent, prefix = '', suffix = '', decimals = 1, length = 100, fill = '█', printEnd = "\r"):
+    """
+    Call in a loop to create terminal progress bar string
+    @params:
+        percent     - Required  : current percentage (Int)
+        prefix      - Optional  : prefix string (Str)
+        suffix      - Optional  : suffix string (Str)
+        decimals    - Optional  : positive number of decimals in percent complete (Int)
+        length      - Optional  : character length of bar (Int)
+        fill        - Optional  : bar fill character (Str)
+        printEnd    - Optional  : end character (e.g. "\r", "\r\n") (Str)
+    """
+    if percent == -1:
+        percent = 0
+    filledLength = int(length * (percent / 100 ))
+    bar = fill * filledLength + '-' * (length - filledLength)
+    percent2dec = "%.2f" % percent
+    print(f'\r{prefix} |{bar}| {percent2dec}% {suffix}', end = printEnd)
+    # Print New Line on Complete
+    if percent == 100: 
+        print()