Merge pull request #6 from sparkfun/release_candidate

v1.1.1 : Handle non-standard (modified) layer names

Author: PaulZC

SparkFunKiCadPanelizer/dialog/dialog.py

@@ -118,10 +118,13 @@ def __init__(self, parent, config, layertable, ordering, panelizer, func):
         self.vscore.LayersGrid.AppendRows(len(self.layertable))
         # Initialize them
         row = 0
-        for layer in self.layertable.keys():
+        for layer, names in self.layertable.items():
             self.vscore.LayersGrid.SetCellValue(row, 0, "0") # JSON style
             self.vscore.LayersGrid.SetCellRenderer(row, 0, wx.grid.GridCellBoolRenderer())
-            self.vscore.LayersGrid.SetCellValue(row, 1, layer)
+            layerName = names['standardName']
+            if names['actualName'] != names['standardName']:
+                layerName += " (" + names['actualName'] + ")"
+            self.vscore.LayersGrid.SetCellValue(row, 1, layerName)
             self.vscore.LayersGrid.SetReadOnly(row, 1)
             row += 1
 
@@ -187,7 +190,10 @@ def CurrentSettings(self):
             if self.vscore_layer in item:
                 for row in range(self.vscore.LayersGrid.GetNumberRows()):
                     if self.vscore.LayersGrid.GetCellValue(row, 0) == "1":
-                        params.update({self.vscore_layer: self.vscore.LayersGrid.GetCellValue(row, 1)})
+                        layername = self.vscore.LayersGrid.GetCellValue(row, 1)
+                        if " (" in layername:
+                            layername = layername[:layername.find(" (")] # Trim the actual name - if present
+                        params.update({self.vscore_layer: layername})
             else:
                 obj = getattr(self.general, "m_{}".format(item))
                 if hasattr(obj, "GetValue"):

SparkFunKiCadPanelizer/panelizer/panelizer.py

@@ -306,8 +306,32 @@ def startPanelizer(self, args, board=None, ordering=None, logger=None):
         # Set up layer table
         layertable = {}
         numlayers = pcbnew.PCB_LAYER_ID_COUNT
+        edgeLayerNumber = None
+        vScoreLayerNumber = None
+        vScoreTextLayerNumber = None
         for i in range(numlayers):
-            layertable[board.GetLayerName(i)] = i
+            layertable[i] = {'standardName': board.GetStandardLayerName(i), 'actualName': board.GetLayerName(i)}
+            if "Edge.Cuts" in board.GetStandardLayerName(i):
+                edgeLayerNumber = i
+            if V_SCORE_LAYER in board.GetStandardLayerName(i):
+                vScoreLayerNumber = i
+            if V_SCORE_TEXT_LAYER in board.GetStandardLayerName(i):
+                vScoreTextLayerNumber = i
+
+        if edgeLayerNumber is None:
+            report += "Edge.Cuts not found in layertable. Quitting.\n"
+            sysExit = 2
+            return sysExit, report    
+
+        if vScoreLayerNumber is None:
+            report += V_SCORE_LAYER + " not found in layertable. Quitting.\n"
+            sysExit = 2
+            return sysExit, report    
+
+        if vScoreTextLayerNumber is None:
+            report += V_SCORE_TEXT_LAYER + " not found in layertable. Quitting.\n"
+            sysExit = 2
+            return sysExit, report    
 
         # Get dimensions of board
         # Note: the bounding box width and height _include_ the Edge.Cuts line width.
@@ -324,7 +348,7 @@ def startPanelizer(self, args, board=None, ordering=None, logger=None):
         cutWidth = 0
         drawings = board.GetDrawings()
         for drawing in drawings:
-            if drawing.IsOnLayer(layertable["Edge.Cuts"]):
+            if drawing.IsOnLayer(edgeLayerNumber):
                 if drawing.GetWidth() > cutWidth:
                     cutWidth = drawing.GetWidth()
         #report += "Subtracting Edge.Cuts line width of {}mm.\n".format(cutWidth / SCALE)
@@ -404,7 +428,7 @@ def startPanelizer(self, args, board=None, ordering=None, logger=None):
         sparkxLogoSeen = False
         solderMask = None
         silkscreen = None
-        numLayers = None
+        numLayers = "Layers: {}".format(board.GetCopperLayerCount())
         controlledImpedance = None
         finish = None
         thickness = None
@@ -427,11 +451,6 @@ def startPanelizer(self, args, board=None, ordering=None, logger=None):
                 drill = sourceTrack.GetDrill()
                 if drill < minViaDrill:
                     minViaDrill = drill
-            layer = sourceTrack.GetLayerName()
-            if numLayers is None and ("In1.Cu" in layer or "In2.Cu" in layer):
-                numLayers = "Layers: 4"
-            if "In3.Cu" in layer or "In4.Cu" in layer:
-                numLayers = "Layers: 6"
             for x in range(0, NUM_X):  # iterate through x direction
                 for y in range(0, NUM_Y):  # iterate through y direction
                     if (x != 0) or (y != 0):  # do not duplicate source object to location
@@ -619,7 +638,7 @@ def startPanelizer(self, args, board=None, ordering=None, logger=None):
         # Erase all existing edgeCuts objects (individual board outlines)
         #drawings = board.GetDrawings()
         #for drawing in drawings:
-        #    if drawing.IsOnLayer(layertable["Edge.Cuts"]):
+        #    if drawing.IsOnLayer(edgeLayerNumber):
         #        drawing.DeleteStructure()
 
         # Rail Edge.Cuts
@@ -742,7 +761,7 @@ def startPanelizer(self, args, board=None, ordering=None, logger=None):
             board.Add(edge)
             edge.SetStart(pcbnew.VECTOR2I(int(cut[0]), int(cut[1])))
             edge.SetEnd(pcbnew.VECTOR2I(int(cut[2]), int(cut[3])))
-            edge.SetLayer(layertable["Edge.Cuts"])
+            edge.SetLayer(edgeLayerNumber)
 
         # Re-calculate board dimensions with new edge cuts
         panelWidth = board.GetBoardEdgesBoundingBox().GetWidth()
@@ -806,7 +825,7 @@ def startPanelizer(self, args, board=None, ordering=None, logger=None):
             v_score_line = pcbnew.PCB_SHAPE(board)
             v_score_line.SetStart(pcbnew.VECTOR2I(int(x_loc), int(vscore_top)))
             v_score_line.SetEnd(pcbnew.VECTOR2I(int(x_loc), int(vscore_bottom)))
-            v_score_line.SetLayer(layertable[V_SCORE_LAYER])
+            v_score_line.SetLayer(vScoreLayerNumber)
             v_score_line.SetWidth(int(V_SCORE_WIDTH * SCALE))
             board.Add(v_score_line)
             v_score_text = pcbnew.PCB_TEXT(board)
@@ -818,7 +837,7 @@ def startPanelizer(self, args, board=None, ordering=None, logger=None):
             v_score_text.SetTextSize(
                 pcbnew.VECTOR2I(SCALE * V_SCORE_TEXT_SIZE, SCALE * V_SCORE_TEXT_SIZE)
             )
-            v_score_text.SetLayer(layertable[V_SCORE_TEXT_LAYER])
+            v_score_text.SetLayer(vScoreTextLayerNumber)
             v_score_text.SetTextAngle(pcbnew.EDA_ANGLE(900, pcbnew.TENTHS_OF_A_DEGREE_T))
             board.Add(v_score_text)
 
@@ -856,7 +875,7 @@ def startPanelizer(self, args, board=None, ordering=None, logger=None):
             v_score_line = pcbnew.PCB_SHAPE(board)
             v_score_line.SetStart(pcbnew.VECTOR2I(int(vscore_left), int(y_loc)))
             v_score_line.SetEnd(pcbnew.VECTOR2I(int(vscore_right), int(y_loc)))
-            v_score_line.SetLayer(layertable[V_SCORE_LAYER])
+            v_score_line.SetLayer(vScoreLayerNumber)
             v_score_line.SetWidth(int(V_SCORE_WIDTH * SCALE))
             board.Add(v_score_line)
             v_score_text = pcbnew.PCB_TEXT(board)
@@ -868,7 +887,7 @@ def startPanelizer(self, args, board=None, ordering=None, logger=None):
             v_score_text.SetTextSize(
                 pcbnew.VECTOR2I(SCALE * V_SCORE_TEXT_SIZE, SCALE * V_SCORE_TEXT_SIZE)
             )
-            v_score_text.SetLayer(layertable[V_SCORE_TEXT_LAYER])
+            v_score_text.SetLayer(vScoreTextLayerNumber)
             v_score_text.SetTextAngle(pcbnew.EDA_ANGLE(0, pcbnew.TENTHS_OF_A_DEGREE_T))
             board.Add(v_score_text)
 
@@ -919,7 +938,7 @@ def startPanelizer(self, args, board=None, ordering=None, logger=None):
             route_text = pcbnew.PCB_TEXT(board)
             route_text.SetText("ROUTE OUT")
             route_text.SetTextSize(pcbnew.VECTOR2I(SCALE * V_SCORE_TEXT_SIZE, SCALE * V_SCORE_TEXT_SIZE))
-            route_text.SetLayer(layertable[V_SCORE_TEXT_LAYER])
+            route_text.SetLayer(vScoreLayerNumber)
             route_text.SetHorizJustify(pcbnew.GR_TEXT_H_ALIGN_CENTER)
             route_text.SetPosition(pcbnew.VECTOR2I(pos[0], pos[1]))
             route_text.SetTextAngle(pcbnew.EDA_ANGLE(pos[2], pcbnew.TENTHS_OF_A_DEGREE_T))
@@ -930,7 +949,7 @@ def startPanelizer(self, args, board=None, ordering=None, logger=None):
             route_text = pcbnew.PCB_TEXT(board)
             route_text.SetText("DO NOT REMOVE")
             route_text.SetTextSize(pcbnew.VECTOR2I(SCALE * V_SCORE_TEXT_SIZE, SCALE * V_SCORE_TEXT_SIZE))
-            route_text.SetLayer(layertable[V_SCORE_TEXT_LAYER])
+            route_text.SetLayer(vScoreTextLayerNumber)
             route_text.SetHorizJustify(pcbnew.GR_TEXT_H_ALIGN_CENTER)
             route_text.SetPosition(pcbnew.VECTOR2I(arrayCenter.x, arrayCenter.y))
             board.Add(route_text)

SparkFunKiCadPanelizer/plugin.py

@@ -74,20 +74,19 @@ def Run(self):
         layertable = {}
         numlayers = pcbnew.PCB_LAYER_ID_COUNT
         for i in range(numlayers):
-            layertable[board.GetLayerName(i)] = i
+            layertable[i] = {'standardName': board.GetStandardLayerName(i), 'actualName': board.GetLayerName(i)}
 
         # Check the number of copper layers. Delete unwanted layers from the table.
         wantedCopper = []
-        if board.GetCopperLayerCount() >= 2:
-            wantedCopper.extend(['F.Cu','B.Cu'])
-        if board.GetCopperLayerCount() >= 4:
-            wantedCopper.extend(['In1.Cu','In2.Cu'])
-        if board.GetCopperLayerCount() >= 6:
-            wantedCopper.extend(['In3.Cu','In4.Cu'])
+        wantedCopper.append("F.Cu")
+        wantedCopper.append("B.Cu")
+        if (board.GetCopperLayerCount() > 2):
+            for i in range(1, board.GetCopperLayerCount() - 1):
+                wantedCopper.append("In{}.Cu".format(i))
         deleteLayers = []
-        for layer in layertable.keys():
-            if layer[-3:] == ".Cu":
-                if layer not in wantedCopper:
+        for layer, names in layertable.items():
+            if names['standardName'][-3:] == ".Cu":
+                if names['standardName'] not in wantedCopper:
                     deleteLayers.append(layer)
         for layer in deleteLayers:
             layertable.pop(layer, None)

SparkFunKiCadPanelizer/resource/_version.py

@@ -1 +1 @@
-__version__ = "1.1.0"
+__version__ = "1.1.1"

SparkFunKiCadPanelizer/test_dialog.py

@@ -11,7 +11,9 @@ def OnInit(self):
 
         config_file = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'panel_config.json')
         ordering_instructions = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'ordering_instructions.txt')
-        layertable = {'F.Cu': 1, 'User.Comments': 2, 'User.1':3}
+        layertable = {0: {'standardName': 'F.Cu', 'actualName': 'F-Cu-Renamed'},
+                      1: {'standardName': 'User.Comments', 'actualName': 'User-Comments-Renamed'},
+                      2: {'standardName': 'User.1', 'actualName': 'User-1-Renamed'}}
 
         self.frame = frame = Dialog(None, config_file, layertable, ordering_instructions, Panelizer(), self.run)
         if frame.ShowModal() == wx.ID_OK: