commit b9f45f71351e370d63a65ed4fb89f85eebfb7d24 Author: Benny Megidish Date: Thu Jun 2 19:41:42 2022 +0300 feat: initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b694934 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.venv \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..64a6213 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2022 Benny Megidish + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..877b188 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# JLC PCB Plug-in for KiCad + +## 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 from the official KiCad repositories +Just open the "Plugin and Content Manager" from the KiCad main menu an install the "PCBWay Plug-in for KiCad" plugin from the selection list. + +### Manual installation +Download the latest ZIP file from https://github.com/bennymeg/JLC-Plugin-for-KiCad. Open the "Plugin and Content Manager" from the KiCads main window and install the ZIP file via "Install from File". + +## Author + +Benny Megidish diff --git a/metadata.json b/metadata.json new file mode 100644 index 0000000..9e2c805 --- /dev/null +++ b/metadata.json @@ -0,0 +1,31 @@ +{ + "$schema": "https://go.kicad.org/pcm/schemas/v1", + "name": "JLC PCB Plugin for KiCad", + "description": "Toolkit for automating PCB fabrication process with KiCad and JLC PCB", + "description_full": "Toolkit for automating PCB fabrication process with KiCad and JLC PCB", + "identifier": "com.github.bennymeg.JLC-Plugin-for-KiCad", + "type": "plugin", + "author": { + "name": "Benny Megidish", + "contact": { + "web": "https://github.com/bennymeg/JLC-Plugin-for-KiCad" + } + }, + "maintainer": { + "name": "Benny Megidish", + "contact": { + "web": "https://github.com/bennymeg/JLC-Plugin-for-KiCad" + } + }, + "license": "MIT", + "resources": { + "homepage": "https://github.com/bennymeg/JLC-Plugin-for-KiCad" + }, + "versions": [ + { + "version": "0.0.1", + "status": "testing", + "kicad_version": "6.00" + } + ] +} \ No newline at end of file diff --git a/plugins/__init__.py b/plugins/__init__.py new file mode 100644 index 0000000..822037f --- /dev/null +++ b/plugins/__init__.py @@ -0,0 +1,8 @@ +try: + from .plugin import Plugin + plugin = Plugin() + plugin.register() +except Exception as e: + import logging + root = logging.getLogger() + root.debug(repr(e)) diff --git a/plugins/config.py b/plugins/config.py new file mode 100644 index 0000000..0f6b4a5 --- /dev/null +++ b/plugins/config.py @@ -0,0 +1,23 @@ +import pcbnew + +baseUrl = 'https://www.jlcpcb.com' + +netlistFileName = 'netlist.ipc' +placementFileName = 'positions.csv' +bomFileName = 'bom.csv' +gerberArchiveName = 'gerber.zip' +outputFolder = 'production' + +plotPlan = [ + ("F.Cu", pcbnew.F_Cu, "Top Layer"), + ("B.Cu", pcbnew.B_Cu, "Bottom Layer"), + ("In1.Cu", pcbnew.In1_Cu, "Internal plane 1"), + ("In2.Cu", pcbnew.In2_Cu, "Internal plane 2"), + ("F.SilkS", pcbnew.F_SilkS, "Top Silkscreen"), + ("B.SilkS", pcbnew.B_SilkS, "Bottom Silkscreen"), + ("F.Mask", pcbnew.F_Mask, "Top Soldermask"), + ("B.Mask", pcbnew.B_Mask, "Bottom Soldermask"), + ("F.Paste", pcbnew.F_Paste, "Top Paste (Stencil)"), + ("B.Paste", pcbnew.B_Paste, "Bottom Paste (Stencil)"), + ("Edge.Cuts", pcbnew.Edge_Cuts, "Board Outline") +] diff --git a/plugins/icon.png b/plugins/icon.png new file mode 100644 index 0000000..4df28ba Binary files /dev/null and b/plugins/icon.png differ diff --git a/plugins/plugin.py b/plugins/plugin.py new file mode 100644 index 0000000..0b0ceae --- /dev/null +++ b/plugins/plugin.py @@ -0,0 +1,59 @@ +import wx +import pcbnew + +from .thread import * +from .result_event import * + + +class KiCadToJLCForm(wx.Frame): + def __init__(self): + wx.Dialog.__init__( + self, + None, + id=wx.ID_ANY, + title=u"Processing...", + pos=wx.DefaultPosition, + size=wx.DefaultSize, + style=wx.DEFAULT_DIALOG_STYLE) + + self.SetSizeHints(wx.DefaultSize, wx.DefaultSize) + + bSizer1 = wx.BoxSizer(wx.VERTICAL) + + self.m_gaugeStatus = wx.Gauge( + self, wx.ID_ANY, 100, wx.DefaultPosition, wx.Size( + 300, 20), wx.GA_HORIZONTAL) + self.m_gaugeStatus.SetValue(0) + bSizer1.Add(self.m_gaugeStatus, 0, wx.ALL, 5) + + self.SetSizer(bSizer1) + self.Layout() + bSizer1.Fit(self) + + self.Centre(wx.BOTH) + + EVT_RESULT(self, self.updateDisplay) + ProcessThread(self) + + def updateDisplay(self, status): + if status.data == -1: + pcbnew.Refresh() + self.Destroy() + else: + self.m_gaugeStatus.SetValue(status.data) + + +class Plugin(pcbnew.ActionPlugin): + def __init__(self): + self.name = "JLC Plugin for KiCad" + self.category = "Manufacturing" + self.description = "Toolkit for automating PCB fabrication process with KiCad and JLC PCB" + self.pcbnew_icon_support = hasattr(self, "show_toolbar_button") + self.show_toolbar_button = True + self.icon_file_name = os.path.join( + os.path.dirname(__file__), 'icon.png') + self.dark_icon_file_name = os.path.join( + os.path.dirname(__file__), 'icon.png') + + def Run(self): + KiCadToJLCForm().Show() diff --git a/plugins/result_event.py b/plugins/result_event.py new file mode 100644 index 0000000..fc5f3b0 --- /dev/null +++ b/plugins/result_event.py @@ -0,0 +1,14 @@ +import wx + +EVT_RESULT_ID = wx.NewId() + + +def EVT_RESULT(win, func): + win.Connect(-1, -1, EVT_RESULT_ID, func) + + +class ResultEvent(wx.PyEvent): + def __init__(self, data): + wx.PyEvent.__init__(self) + self.SetEventType(EVT_RESULT_ID) + self.data = data diff --git a/plugins/thread.py b/plugins/thread.py new file mode 100644 index 0000000..e923f3c --- /dev/null +++ b/plugins/thread.py @@ -0,0 +1,202 @@ +# original copyright Aisler and licensed under the MIT license. +# https://opensource.org/licenses/MIT + +# from urllib import response +# import json +# import requests +import os +import wx +import csv +import shutil +import tempfile +import webbrowser +from threading import Thread +from .result_event import * +from .config import * + + +class ProcessThread(Thread): + def __init__(self, wxObject): + Thread.__init__(self) + self.wxObject = wxObject + self.start() + + def run(self): + + temp_dir = tempfile.mkdtemp() + _, temp_file = tempfile.mkstemp() + board = pcbnew.GetBoard() + title_block = board.GetTitleBlock() + + # configure gerber + self.report(5) + + settings = board.GetDesignSettings() + settings.m_SolderMaskMargin = 0 + settings.m_SolderMaskMinWidth = 0 + + pctl = pcbnew.PLOT_CONTROLLER(board) + + popt = pctl.GetPlotOptions() + popt.SetOutputDirectory(temp_dir) + popt.SetPlotFrameRef(False) + popt.SetSketchPadLineWidth(pcbnew.FromMM(0.1)) + popt.SetAutoScale(False) + popt.SetScale(1) + popt.SetMirror(False) + popt.SetUseGerberAttributes(True) + popt.SetExcludeEdgeLayer(True) + popt.SetUseGerberProtelExtensions(False) + popt.SetUseAuxOrigin(True) + popt.SetSubtractMaskFromSilk(False) + popt.SetDrillMarksType(0) # NO_DRILL_SHAPE + + # generate gerber + self.report(10) + for layer_info in plotPlan: + if board.IsLayerEnabled(layer_info[1]): + pctl.SetLayer(layer_info[1]) + pctl.OpenPlotfile( + layer_info[0], + pcbnew.PLOT_FORMAT_GERBER, + layer_info[2]) + pctl.PlotLayer() + + pctl.ClosePlot() + + #generate drill file + self.report(15) + drlwriter = pcbnew.EXCELLON_WRITER(board) + + drlwriter.SetOptions( + False, + True, + board.GetDesignSettings().GetAuxOrigin(), + False) + drlwriter.SetFormat(False) + drlwriter.CreateDrillandMapFilesSet(pctl.GetPlotDirName(), True, False) + + # generate netlist + self.report(25) + netlist_writer = pcbnew.IPC356D_WRITER(board) + netlist_writer.Write(os.path.join(temp_dir, netlistFileName)) + + # generate pick and place file + self.report(40) + components = [] + bom = [] + if hasattr(board, 'GetModules'): + footprints = list(board.GetModules()) + else: + footprints = list(board.GetFootprints()) + + for i, f in enumerate(footprints): + try: + footprint_name = str(f.GetFPID().GetFootprintName()) + except AttributeError: + footprint_name = str(f.GetFPID().GetLibItemName()) + + layer = { + pcbnew.F_Cu: 'top', + pcbnew.B_Cu: 'bottom', + }.get(f.GetLayer()) + + mount_type = { + 0: 'smt', + 1: 'tht', + 2: 'smt' + }.get(f.GetAttributes()) + + components.append({ + 'Designator': f.GetReference(), + 'Mid X': (f.GetPosition()[0] - board.GetDesignSettings().GetAuxOrigin()[0]) / 1000000.0, + 'Mid Y': (f.GetPosition()[1] - board.GetDesignSettings().GetAuxOrigin()[1]) * -1.0 / 1000000.0, + 'Rotation': f.GetOrientation() / 10.0, + 'Layer': layer, + }) + + bom.append({ + 'Designator': f.GetReference(), + 'Footprint': footprint_name, + 'Quantity': 1, + 'Value': f.GetValue(), + 'Mount': mount_type, + 'LCSC Part #': self.getMpnFromFootprint(f), + }) + + with open((os.path.join(temp_dir, placementFileName)), 'w') as outfile: + header = True + csv_writer = csv.writer(outfile) + + for component in components: + if header: + # Writing headers of CSV file + csv_writer.writerow(component.keys()) + header = False + + # Writing data of CSV file + csv_writer.writerow(component.values()) + + # generate BOM file + self.report(60) + with open((os.path.join(temp_dir, bomFileName)), 'w') as outfile: + header = True + csv_writer = csv.writer(outfile) + + for component in bom: + if header: + # Writing headers of CSV file + csv_writer.writerow(component.keys()) + header = False + + # Writing data of CSV file + csv_writer.writerow(component.values()) + + + # generate production archive + self.report(75) + temp_file = shutil.make_archive(temp_file, 'zip', temp_dir) + + # remove non essential files + for item in os.listdir(temp_dir): + if not item.endswith(".zip") and not item.endswith(".csv"): + os.remove(os.path.join(temp_dir, item)) + + # upload files + self.report(87.5) + boardWidth = pcbnew.Iu2Millimeter(board.GetBoardEdgesBoundingBox().GetWidth()) + boardHeight = pcbnew.Iu2Millimeter(board.GetBoardEdgesBoundingBox().GetHeight()) + boardLayer = board.GetCopperLayerCount() + + # files = {'upload[file]': open(temp_file, 'rb')} + # upload_url = baseUrl + '/Common/KiCadUpFile/' + + # response = requests.post( + # upload_url, files=files, data={'boardWidth':boardWidth,'boardHeight':boardHeight,'boardLayer':boardLayer}) + + # urls = json.loads(response.content) + + readsofar = 0 + totalsize = os.path.getsize(temp_file) + with open(temp_file, 'rb') as file: + while True: + data = file.read(10) + if not data: + break + readsofar += len(data) + percent = readsofar * 1e2 / totalsize + self.report(75 + percent / 8) + + webbrowser.open(temp_dir) + # webbrowser.open(urls['redirect']) + self.report(-1) + + def report(self, status): + wx.PostEvent(self.wxObject, ResultEvent(status)) + + def getMpnFromFootprint(self, f): + keys = ['mpn', 'MPN', 'Mpn', 'JLC_MPN', 'LCSC_MPN', 'LCSC Part #'] + for key in keys: + if f.HasProperty(key): + return f.GetProperty(key) + \ No newline at end of file diff --git a/resources/icon.png b/resources/icon.png new file mode 100644 index 0000000..4df28ba Binary files /dev/null and b/resources/icon.png differ