Path: Z depth correction from probe data

src/Mod/Path/PathScripts/PathProbe.py

@@ -0,0 +1,107 @@
+# -*- coding: utf-8 -*-
+
+# ***************************************************************************
+# *                                                                         *
+# *   Copyright (c) 2018 sliptonic <shopinthewoods@gmail.com>               *
+# *                                                                         *
+# *   This program is free software; you can redistribute it and/or modify  *
+# *   it under the terms of the GNU Lesser General Public License (LGPL)    *
+# *   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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
+# *   USA                                                                   *
+# *                                                                         *
+# ***************************************************************************
+
+from __future__ import print_function
+
+import FreeCAD
+import Path
+import PathScripts.PathLog as PathLog
+import PathScripts.PathOp as PathOp
+import PathScripts.PathUtils as PathUtils
+
+#from PathScripts.PathUtils import waiting_effects
+from PySide import QtCore
+
+__title__ = "Path Probing Operation"
+__author__ = "sliptonic (Brad Collette)"
+__url__ = "http://www.freecadweb.org"
+__doc__ = "Path Probing operation."
+
+if False:
+    PathLog.setLevel(PathLog.Level.DEBUG, PathLog.thisModule())
+    PathLog.trackModule(PathLog.thisModule())
+else:
+    PathLog.setLevel(PathLog.Level.INFO, PathLog.thisModule())
+
+
+# Qt tanslation handling
+def translate(context, text, disambig=None):
+    return QtCore.QCoreApplication.translate(context, text, disambig)
+
+
+class ObjectProbing(PathOp.ObjectOp):
+    '''Proxy object for Probing operation.'''
+
+    def opFeatures(self, obj):
+        '''opFeatures(obj) ... Probing works on the stock object.'''
+        return PathOp.FeatureDepths | PathOp.FeatureHeights | PathOp.FeatureTool
+
+    def initOperation(self, obj):
+        obj.addProperty("App::PropertyLength", "Xoffset", "Probe", QtCore.QT_TRANSLATE_NOOP("App::Property", "X offset between tool and probe"))
+        obj.addProperty("App::PropertyLength", "Yoffset", "Probe", QtCore.QT_TRANSLATE_NOOP("App::Property", "Y offset between tool and probe"))
+        obj.addProperty("App::PropertyInteger", "PointCountX", "Probe", QtCore.QT_TRANSLATE_NOOP("App::Property", "Number of points to probe in X direction")).PointCountX=3
+        obj.addProperty("App::PropertyInteger", "PointCountY", "Probe", QtCore.QT_TRANSLATE_NOOP("App::Property", "Number of points to probe in Y direction")).PointCountY=3
+
+    def drange(self, start=1.0, stop=5.0, step=1.0):
+        r = start
+        while r <= stop:
+            yield r
+            r += step
+
+    def opExecute(self, obj):
+        '''opExecute(obj) ... generate probe locations.'''
+        PathLog.track()
+        self.commandlist.append(Path.Command("(Begin Probing)"))
+
+        stock = PathUtils.findParentJob(obj).Stock
+        bb = stock.Shape.BoundBox
+
+        xdist = (bb.XMax - bb.XMin)/ (obj.PointCountX - 1)
+        ydist = (bb.YMax - bb.YMin)/ (obj.PointCountY - 1)
+
+        self.commandlist.append(Path.Command("(PROBEOPEN probe_points.txt)"))
+
+        self.commandlist.append(Path.Command("G0", {"X":bb.XMin, "Y":bb.YMin, "Z":obj.SafeHeight.Value}))
+        for x in self.drange(bb.XMin, bb.XMax, xdist):
+            for y in self.drange(bb.YMin, bb.YMax, ydist):
+                self.commandlist.append(Path.Command("G0", {"X":x + obj.Xoffset.Value, "Y":y + obj.Yoffset.Value,  "Z":obj.SafeHeight.Value}))
+                self.commandlist.append(Path.Command("G38.2",{"Z":obj.FinalDepth.Value, "F":obj.ToolController.VertFeed.Value}))
+                self.commandlist.append(Path.Command("G0", {"Z":obj.SafeHeight.Value}))
+
+        self.commandlist.append(Path.Command("(PROBECLOSE)"))
+
+
+    def opSetDefaultValues(self, obj, job):
+        '''opSetDefaultValues(obj, job) ... set default value for RetractHeight'''
+
+def SetupProperties():
+    setup = []
+    return setup
+
+def Create(name, obj = None):
+    '''Create(name) ... Creates and returns a Probing operation.'''
+    if obj is None:
+        obj = FreeCAD.ActiveDocument.addObject("Path::FeaturePython", name)
+    proxy = ObjectProbing(obj, name)
+    return obj