Connector Wuerth: Add WR-PHD Bottom Entry series

cadquery/FCAD_script_generator/Connector_Wuerth_WR-PHD/wuerth_wr_phd_bottom_entry.py

@@ -0,0 +1,262 @@
+# -*- coding: utf8 -*-
+#!/usr/bin/python
+#
+# This was originaly derived from a cadquery script for generating PDIP models in X3D format
+# from https://bitbucket.org/hyOzd/freecad-macros
+# author hyOzd
+#
+# Adapted by easyw for step and vrlm export
+# See https://github.com/easyw/kicad-3d-models-in-freecad
+
+## requirements
+## cadquery FreeCAD plugin
+##   https://github.com/jmwright/cadquery-freecad-module
+
+## to run the script just do: freecad scriptName modelName
+## e.g. FreeCAD export_conn_jst_xh.py all
+
+## the script will generate STEP and VRML parametric models
+## to be used with kicad StepUp script
+
+#* These are FreeCAD & cadquery tools                                       *
+#* to export generated models in STEP & VRML format.                        *
+#*                                                                          *
+#* cadquery script for generating JST-XH models in STEP AP214               *
+#*   Copyright (c) 2016                                                     *
+#* Joel https://github.com/myfreescalewebpage                               *
+#* All trademarks within this guide belong to their legitimate owners.      *
+#*                                                                          *
+#*   This program is free software; you can redistribute it and/or modify   *
+#*   it under the terms of the GNU General Public License (GPL)             *
+#*   as published by the Free Software Foundation; either version 2 of      *
+#*   the License, or (at your option) any later version.                    *
+#*   for detail see the LICENCE text file.                                  *
+#*                                                                          *
+#*   This program is distributed in the hope that it will be useful,        *
+#*   but WITHOUT ANY WARRANTY; without even the implied warranty of         *
+#*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+#*   GNU Library General Public License for more details.                   *
+#*                                                                          *
+#*   You should have received a copy of the GNU Library General Public      *
+#*   License along with this program; if not, write to the Free Software    *
+#*   Foundation, Inc.,                                                      *
+#*   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA           *
+#*                                                                          *
+#****************************************************************************
+
+from __future__ import division
+
+import sys, os
+import yaml
+import datetime
+sys.path.append("../_tools")
+import add_license
+
+if FreeCAD.GuiUp:
+    from PySide import QtCore, QtGui
+
+try:
+    Gui.activateWorkbench("CadQueryWorkbench")
+    import cadquery as cq
+    from Helpers import show
+except Exception as e:
+    if QtGui is not None:
+        reply = QtGui.QMessageBox.information(None, "Info ...", "Missing CadQuery 0.3.0 or later Module!\r\n\r\nhttps://github.com/jmwright/cadquery-freecad-module/wiki\n")
+
+import importlib
+from cqToolsExceptions import *
+import cq_cad_tools
+importlib.reload(cq_cad_tools)
+from cq_cad_tools import multiFuseObjs_wColors, GetListOfObjects, restore_Main_Tools, exportSTEP, close_CQ_Example, saveFCdoc, z_RotateObject, runGeometryCheck
+
+try:
+    close_CQ_Example(App, Gui)
+except:
+    FreeCAD.Console.PrintMessage("Can't close example")
+
+import ImportGui
+
+import exportPartToVRML as expVRML
+import shaderColors
+
+# License information
+class LICENCE_Info():
+    STR_licAuthor = "Joel"
+    STR_licEmail = "[email protected]"
+    STR_licOrgSys = ""
+    STR_licPreProc = ""
+    LIST_license = ["",]
+
+# Function used to generate pin socket
+def generate_pinpockets(params, part_params):
+
+    # Create a pin pocket, the volume to be removed is extruded, later it will be cut in the body
+    if params['type'] == 'SMD':
+        pocket = cq.Workplane("XY", origin=(0, 0) + (params['height'],))\
+            .rect(1.7, 1.7).extrude(-0.2)\
+            .faces("<Z").edges().chamfer(0.2-0.001)\
+            .faces("<Z").rect(1.3, 1.3).extrude(-params['height'] + 0.2 + 0.4)\
+            .faces("<Z").rect(1.3, 0.5).extrude(-0.4)
+    else:
+        pocket = cq.Workplane("XY", origin=(0, 0) + (params['height'],))\
+            .rect(1.4, 1.4).extrude(-0.2)\
+            .faces("<Z").edges().chamfer(0.2-0.001)\
+            .faces("<Z").rect(1.0, 1.0).extrude(-0.3)\
+            .faces("<Z").rect(1.6, 2).extrude(-params['height'] + 0.2 + 0.3 + 0.5)
+        rpocket = cq.Workplane("XY", origin=(0.25, 0) + (0,))\
+            .rect(2.1, 2).extrude(0.5)
+        pocket = pocket.union(rpocket)
+
+    # Append to have one row of pockets
+    objs = []
+    for i in range(0, part_params['pins'] // part_params['rows']):
+        objs.append(pocket.translate((params['pitch']/2, (params['pitch']*(part_params['pins']//2-1))/2-i*params['pitch'], 0)))
+    o = objs[0]
+    for i in range(1, len(objs)):
+        o = o.union(objs[i])
+    pockets = o
+
+    # Create second row of pockets
+    pockets = pockets.union(pockets.rotate((0,0,0), (0,0,1), 180))
+
+    return pockets
+
+# Function used to generate body
+def generate_body(params, part_params):
+
+    # Create body
+    body = cq.Workplane("XY").rect(params['width'], 2*params['top']+params['pitch']*(part_params['pins']//2-1)).extrude(params['height']).faces(">Y")
+
+    # Remove pin pocket
+    body = body.cut(generate_pinpockets(params, part_params))
+    if params['type'] == 'SMD':
+        body = body.faces("<Z").rect(params['width']-2*0.58, 2*params['top']+params['pitch']*(part_params['pins']//2-1)).cutBlind(0.2)
+
+    # Translate to the right position
+    body = body.translate((-params['holes']['offset']-params['pitch'] / 2.0, -(params['pitch']*(part_params['pins']//2-1))/2, 0))
+
+    return body
+
+# Function used to generate pins
+def generate_pins(params, part_params):
+
+    # Create a pin
+    if params['type'] == 'SMD':
+        pin = cq.Workplane("XY", (0.1, 0, 0))\
+            .moveTo(0, -0.25).lineTo(1.68, -0.25).lineTo(1.88, -0.05).lineTo(1.88, 0.05).lineTo(1.68, 0.25).lineTo(0, 0.25).close()\
+            .extrude(0.2)
+        pin = pin.faces(">Z").workplane().center(-0.8, 0).rect(0.2, 0.5).extrude(0.4)
+        pin = pin.faces(">Z").workplane().center(-0.1, 0)\
+            .moveTo(0, -0.45).lineTo(-1.1, -0.45).lineTo(-1.1, -0.65).lineTo(0.2, -0.65).lineTo(0.2, 0.65).lineTo(-1.1, 0.65).lineTo(-1.1, 0.45).lineTo(0, 0.45).close()\
+            .extrude(2.9)
+    else:
+        pin = cq.Workplane("YZ", (-0.125, 0, 0))\
+            .moveTo(-0.4, 0.5).lineTo(-0.4, -2.8).lineTo(-0.1, -3.1).lineTo(0.1, -3.1).lineTo(0.4, -2.8).lineTo(0.4, 0.5).close()\
+            .extrude(0.25)
+        pin = pin.faces("<X").workplane().center(0, 1.625).rect(0.8, 0.25).extrude(0.6 if params['type'] == 'Standard' else 1.87)
+        pin = pin.faces(">Z").workplane().center(-(0.6 if params['type'] == 'Standard' else 1.87)/2, 0)\
+            .moveTo(0, -0.75).lineTo(-1.15, -0.75).lineTo(-1.15, -1.0).lineTo(0.25, -1.0).lineTo(0.25, 1.0).lineTo(-1.15, 1.0).lineTo(-1.15, 0.75).lineTo(0, 0.75).close()\
+            .extrude(3.7)
+
+    # Append to have one row of pins
+    objs = []
+    for i in range(0, part_params['pins'] // part_params['rows']):
+        objs.append(pin.translate((params['pitch']/2+(0.35 if params['type'] == 'SMD' else params['holes']['offset']), (params['pitch']*(part_params['pins']//2-1))/2-i*params['pitch'], 0)))
+    o = objs[0]
+    for i in range(1, len(objs)):
+        o = o.union(objs[i])
+    pins = o
+
+    # Create second row of pins
+    pins = pins.union(pins.rotate((0,0,0), (0,0,1), 180))
+
+    # Translate to the right position
+    pins = pins.translate((-params['holes']['offset']-params['pitch'] / 2.0, -(params['pitch']*(part_params['pins']//2-1))/2, 0))
+
+    return pins
+
+# Function used to generate package3d
+def generate_package3d(params, part_params, mpn):
+
+    # License information
+    if LICENCE_Info.LIST_license[0]=="":
+        LIST_license = add_license.LIST_int_license
+    else:
+        LIST_license = LICENCE_Info.LIST_license
+    LIST_license[0] = "Copyright (C) " + datetime.datetime.now().strftime("%Y") + ", " + LICENCE_Info.STR_licAuthor
+
+    # Build model name
+    model_name = "Connector_Wuerth_{series_prefix}_{type}_{rows}x{pins:02d}_P{pitch}_{orientation}_{mpn}".format(
+        series_prefix=params['series_prefix'], type=params['type'], rows=part_params['rows'], pins=part_params['pins']//2, pitch=params['pitch'], orientation=params['orientation'], mpn=mpn)
+    FreeCAD.Console.PrintMessage('\r\nGenerate: ' + model_name + '\r\n')
+
+    # Create new document
+    doc = FreeCAD.newDocument("doc")
+    App.setActiveDocument("doc")
+    App.ActiveDocument = App.getDocument("doc")
+    Gui.ActiveDocument = Gui.getDocument("doc")
+
+    # Generate body
+    body_color_key = "black body"
+    body_color = shaderColors.named_colors[body_color_key].getDiffuseFloat()
+    body = generate_body(params, part_params)
+    show(body, body_color + (0,))
+
+    # Generate pins
+    pins_color_key = "gold pins"
+    pins_color = shaderColors.named_colors[pins_color_key].getDiffuseFloat()
+    pins = generate_pins(params, part_params)
+    show(pins, pins_color + (0,))
+
+    # Finalize
+    doc = FreeCAD.ActiveDocument
+    objs = GetListOfObjects(FreeCAD, doc)
+    restore_Main_Tools()
+    col_body=Gui.ActiveDocument.getObject(objs[0].Name).DiffuseColor[0]
+    col_pin=Gui.ActiveDocument.getObject(objs[1].Name).DiffuseColor[0]
+    material_substitutions={
+        col_body[:-1]:body_color_key,
+        col_pin[:-1]:pins_color_key
+    }
+    expVRML.say(material_substitutions)
+
+    # Create output directory
+    output_dir = 'Connector_Wuerth_{series_prefix}_Bottom-Entry.3dshapes/'.format(series_prefix=params['series_prefix'])
+    if not os.path.isdir(output_dir):
+        os.makedirs(output_dir)
+    filename =  '{output_dir:s}{model_name:s}.wrl'.format(output_dir=output_dir, model_name=model_name)
+
+    # Export wrl file
+    export_objects, used_color_keys = expVRML.determineColors(Gui, objs, material_substitutions)
+    colored_meshes = expVRML.getColoredMesh(Gui, export_objects, 1/2.54)
+    expVRML.writeVRMLFile(colored_meshes, filename, used_color_keys, LIST_license)
+
+    # Export step file
+    exportSTEP(doc, model_name, output_dir, objs[0])
+    add_license.addLicenseToStep(output_dir, '{model_name}.step'.format(
+        model_name=model_name),
+        LIST_license, LICENCE_Info.STR_licAuthor, LICENCE_Info.STR_licEmail, LICENCE_Info.STR_licOrgSys, LICENCE_Info.STR_licPreProc)
+
+    # Force recompute
+    FreeCAD.activeDocument().recompute()
+
+    # Save FCStd document
+    saveFCdoc(App, Gui, doc, model_name, output_dir)
+
+    # Close document
+    doc = FreeCAD.ActiveDocument
+    FreeCAD.closeDocument(doc.Name)
+
+if __name__ == "__main__":
+
+    # Load yaml file for this library
+    with open('./wuerth_wr_phd_bottom_entry.yaml', 'r') as params_stream:
+        try:
+            params = yaml.safe_load(params_stream)
+        except yaml.YAMLError as exc:
+            print(exc)
+
+    # Create each part
+    for series in params:
+        for mpn in params[series]['parts']:
+            generate_package3d(params[series], params[series]['parts'][mpn], mpn)