feat: v1.1.0 - merge bom components

merge similar parts into single entry, sort footprint

README.md

@@ -34,10 +34,14 @@ Add an 'MPN'* field with the LCSC component part number to the symbol's fields p
 | --- | --- | --- | --- | --- | --- | --- | --- |
 
 ### Ignore Footprint in Production Files
-Select 'Exclude from position files' or 'Exclude from BOM' in the symbol's attributes property in order to ignore the footprint from the relevant file.
+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>
+
 ## Author
 
 Benny Megidish

metadata.json

@@ -29,7 +29,7 @@
     ],
     "versions": [
         {
-            "version": "1.0.0",
+            "version": "1.1.0",
             "status": "stable",
             "kicad_version": "6.00"
         }

plugins/process.py

@@ -65,6 +65,9 @@ class ProcessManager:
         else:
             footprints = list(self.board.GetFootprints())
 
+        # sort footprint after designator
+        footprints.sort(key=lambda x: x.GetReference())
+
         # unique designator dictionary
         footprint_designators = defaultdict(int)
         for i, footprint in enumerate(footprints):
@@ -115,27 +118,31 @@ class ProcessManager:
                     unique_id = str(bom_designators[footprint.GetReference()])
                     bom_designators[footprint.GetReference()] -= 1
 
-                # todo: merge similar parts into single entry
+                # merge similar parts into single entry
+                insert = True
+                for component in self.bom:
+                    if component['Footprint'].upper() == footprint_name.upper() and component['Value'].upper() == footprint.GetValue().upper():
+                        component['Designator'] += ", " + "{}{}{}".format(footprint.GetReference(), "" if unique_id == "" else "_", unique_id)
+                        component['Quantity'] += 1
+                        insert = False
 
-                self.bom.append({
-                    'Designator': "{}{}{}".format(footprint.GetReference(), "" if unique_id == "" else "_", unique_id),
-                    'Footprint': footprint_name,
-                    'Quantity': 1,
-                    'Value': footprint.GetValue(),
-                    # 'Mount': mount_type,
-                    'LCSC Part #': self._getMpnFromFootprint(footprint),
-                })
+                # add component to BOM
+                if insert:
+                    self.bom.append({
+                        'Designator': "{}{}{}".format(footprint.GetReference(), "" if unique_id == "" else "_", unique_id),
+                        'Footprint': footprint_name,
+                        'Quantity': 1,
+                        'Value': footprint.GetValue(),
+                        # 'Mount': mount_type,
+                        'LCSC Part #': self._getMpnFromFootprint(footprint),
+                    })
 
         with open((os.path.join(temp_dir, placementFileName)), 'w', newline='', encoding='utf-8') as outfile:
-            header = True
             csv_writer = csv.writer(outfile)
+            # writing headers of CSV file
+            csv_writer.writerow(component.keys())
 
             for component in self.components:
-                if header:
-                    # writing headers of CSV file
-                    csv_writer.writerow(component.keys())
-                    header = False
-
                 # writing data of CSV file
                 if ('**' not in component['Designator']):
                     csv_writer.writerow(component.values())
@@ -143,15 +150,12 @@ class ProcessManager:
     def generate_bom(self, temp_dir):
 
         with open((os.path.join(temp_dir, bomFileName)), 'w', newline='', encoding='utf-8') as outfile:
-            header = True
             csv_writer = csv.writer(outfile)
+            # writing headers of CSV file
+            csv_writer.writerow(self.bom[0].keys())
 
+            # Output all of the component information
             for component in self.bom:
-                if header:
-                    # writing headers of CSV file
-                    csv_writer.writerow(component.keys())
-                    header = False
-
                 # writing data of CSV file
                 if ('**' not in component['Designator']):
                     csv_writer.writerow(component.values())