af2d178e57
* Adding retract annotation to drilling commands checkpoint * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
353 lines
13 KiB
Python
353 lines
13 KiB
Python
# SPDX-License-Identifier: LGPL-2.1-or-later
|
|
|
|
# ***************************************************************************
|
|
# * Copyright (c) 2014 Yorik van Havre <yorik@uncreated.net> *
|
|
# * Copyright (c) 2020 Schildkroet *
|
|
# * *
|
|
# * 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 *
|
|
# * *
|
|
# ***************************************************************************
|
|
|
|
|
|
import FreeCAD
|
|
import Part
|
|
import Path
|
|
import Path.Base.FeedRate as PathFeedRate
|
|
import Path.Base.Generator.drill as drill
|
|
import Path.Base.Generator.linking as linking
|
|
import Path.Base.MachineState as PathMachineState
|
|
import Path.Op.Base as PathOp
|
|
import Path.Op.CircularHoleBase as PathCircularHoleBase
|
|
import PathScripts.PathUtils as PathUtils
|
|
from PySide.QtCore import QT_TRANSLATE_NOOP
|
|
|
|
__title__ = "CAM Drilling Operation"
|
|
__author__ = "sliptonic (Brad Collette)"
|
|
__url__ = "https://www.freecad.org"
|
|
__doc__ = "CAM Drilling operation."
|
|
__contributors__ = "IMBack!"
|
|
|
|
if False:
|
|
Path.Log.setLevel(Path.Log.Level.DEBUG, Path.Log.thisModule())
|
|
Path.Log.trackModule(Path.Log.thisModule())
|
|
else:
|
|
Path.Log.setLevel(Path.Log.Level.INFO, Path.Log.thisModule())
|
|
|
|
translate = FreeCAD.Qt.translate
|
|
|
|
|
|
class ObjectDrilling(PathCircularHoleBase.ObjectOp):
|
|
"""Proxy object for Drilling operation."""
|
|
|
|
@classmethod
|
|
def propertyEnumerations(self, dataType="data"):
|
|
"""helixOpPropertyEnumerations(dataType="data")... return property enumeration lists of specified dataType.
|
|
Args:
|
|
dataType = 'data', 'raw', 'translated'
|
|
Notes:
|
|
'data' is list of internal string literals used in code
|
|
'raw' is list of (translated_text, data_string) tuples
|
|
'translated' is list of translated string literals
|
|
"""
|
|
|
|
# Enumeration lists for App::PropertyEnumeration properties
|
|
enums = {
|
|
"ExtraOffset": [
|
|
(translate("CAM_Drilling", "None"), "None"),
|
|
(translate("CAM_Drilling", "Drill Tip"), "Drill Tip"),
|
|
(translate("CAM_Drilling", "2x Drill Tip"), "2x Drill Tip"),
|
|
], # extra drilling depth to clear drill taper
|
|
}
|
|
|
|
if dataType == "raw":
|
|
return enums
|
|
|
|
data = list()
|
|
idx = 0 if dataType == "translated" else 1
|
|
|
|
Path.Log.debug(enums)
|
|
|
|
for k, v in enumerate(enums):
|
|
data.append((v, [tup[idx] for tup in enums[v]]))
|
|
Path.Log.debug(data)
|
|
|
|
return data
|
|
|
|
def circularHoleFeatures(self, obj):
|
|
"""circularHoleFeatures(obj) ... drilling works on anything, turn on all Base geometries and Locations."""
|
|
return PathOp.FeatureBaseGeometry | PathOp.FeatureLocations | PathOp.FeatureCoolant
|
|
|
|
def onDocumentRestored(self, obj):
|
|
if not hasattr(obj, "chipBreakEnabled"):
|
|
obj.addProperty(
|
|
"App::PropertyBool",
|
|
"chipBreakEnabled",
|
|
"Drill",
|
|
QT_TRANSLATE_NOOP("App::Property", "Use chipbreaking"),
|
|
)
|
|
|
|
if not hasattr(obj, "feedRetractEnabled"):
|
|
obj.addProperty(
|
|
"App::PropertyBool",
|
|
"feedRetractEnabled",
|
|
"Drill",
|
|
QT_TRANSLATE_NOOP("App::Property", "Use G85 boring cycle with feed out"),
|
|
)
|
|
if hasattr(obj, "RetractMode"):
|
|
obj.removeProperty("RetractMode")
|
|
|
|
if not hasattr(obj, "KeepToolDown"):
|
|
obj.addProperty(
|
|
"App::PropertyBool",
|
|
"KeepToolDown",
|
|
"Drill",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property",
|
|
"Apply G99 retraction: only retract to RetractHeight between holes in this operation",
|
|
),
|
|
)
|
|
|
|
def initCircularHoleOperation(self, obj):
|
|
"""initCircularHoleOperation(obj) ... add drilling specific properties to obj."""
|
|
obj.addProperty(
|
|
"App::PropertyLength",
|
|
"PeckDepth",
|
|
"Drill",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property",
|
|
"Incremental Drill depth before retracting to clear chips",
|
|
),
|
|
)
|
|
obj.addProperty(
|
|
"App::PropertyBool",
|
|
"PeckEnabled",
|
|
"Drill",
|
|
QT_TRANSLATE_NOOP("App::Property", "Enable pecking"),
|
|
)
|
|
obj.addProperty(
|
|
"App::PropertyBool",
|
|
"chipBreakEnabled",
|
|
"Drill",
|
|
QT_TRANSLATE_NOOP("App::Property", "Use chipbreaking"),
|
|
)
|
|
obj.addProperty(
|
|
"App::PropertyFloat",
|
|
"DwellTime",
|
|
"Drill",
|
|
QT_TRANSLATE_NOOP("App::Property", "The time to dwell between peck cycles"),
|
|
)
|
|
obj.addProperty(
|
|
"App::PropertyBool",
|
|
"DwellEnabled",
|
|
"Drill",
|
|
QT_TRANSLATE_NOOP("App::Property", "Enable dwell"),
|
|
)
|
|
obj.addProperty(
|
|
"App::PropertyBool",
|
|
"AddTipLength",
|
|
"Drill",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property",
|
|
"Calculate the tip length and subtract from final depth",
|
|
),
|
|
)
|
|
obj.addProperty(
|
|
"App::PropertyDistance",
|
|
"RetractHeight",
|
|
"Drill",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property",
|
|
"The height where cutting feed rate starts and retract height for peck operation",
|
|
),
|
|
)
|
|
obj.addProperty(
|
|
"App::PropertyEnumeration",
|
|
"ExtraOffset",
|
|
"Drill",
|
|
QT_TRANSLATE_NOOP("App::Property", "How far the drilling depth is extended"),
|
|
)
|
|
obj.addProperty(
|
|
"App::PropertyBool",
|
|
"KeepToolDown",
|
|
"Drill",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property",
|
|
"Apply G99 retraction: only retract to RetractHeight between holes in this operation",
|
|
),
|
|
)
|
|
obj.addProperty(
|
|
"App::PropertyBool",
|
|
"feedRetractEnabled",
|
|
"Drill",
|
|
QT_TRANSLATE_NOOP("App::Property", "Use G85 boring cycle with feed out"),
|
|
)
|
|
|
|
def circularHoleExecute(self, obj, holes):
|
|
"""circularHoleExecute(obj, holes) ... generate drill operation for each hole in holes."""
|
|
Path.Log.track()
|
|
machinestate = PathMachineState.MachineState()
|
|
|
|
mode = "G99" if obj.KeepToolDown else "G98"
|
|
|
|
# Calculate offsets to add to target edge
|
|
endoffset = 0.0
|
|
if obj.ExtraOffset == "Drill Tip":
|
|
endoffset = PathUtils.drillTipLength(self.tool)
|
|
elif obj.ExtraOffset == "2x Drill Tip":
|
|
endoffset = PathUtils.drillTipLength(self.tool) * 2
|
|
|
|
# compute the drilling targets
|
|
edgelist = []
|
|
for hole in holes:
|
|
v1 = FreeCAD.Vector(hole["x"], hole["y"], obj.StartDepth.Value)
|
|
v2 = FreeCAD.Vector(hole["x"], hole["y"], obj.FinalDepth.Value - endoffset)
|
|
edgelist.append(Part.makeLine(v1, v2))
|
|
|
|
# build list of solids for collision detection.
|
|
# Include base objects from job
|
|
solids = []
|
|
for base in job.BaseObjects:
|
|
solids.append(base.Shape)
|
|
|
|
# http://linuxcnc.org/docs/html/gcode/g-code.html#gcode:g98-g99
|
|
|
|
# This section is technical debt. The computation of the
|
|
# target shapes should be factored out for reuse.
|
|
# This will likely mean refactoring upstream CircularHoleBase to pass
|
|
# spotshapes instead of holes.
|
|
|
|
# Start computing the Path
|
|
self.commandlist.append(Path.Command("(Begin Drilling)"))
|
|
|
|
# Make sure tool is at a clearance height
|
|
command = Path.Command("G0", {"Z": obj.ClearanceHeight.Value})
|
|
# machine.addCommand(command)
|
|
self.commandlist.append(command)
|
|
|
|
# iterate the edgelist and generate gcode
|
|
firstMove = True
|
|
for edge in edgelist:
|
|
Path.Log.debug(edge)
|
|
|
|
# Get the target start point
|
|
startPoint = edge.Vertexes[0].Point
|
|
|
|
# Get linking moves from current to start of target
|
|
if firstMove: # Build manually
|
|
command = Path.Command("G0", {"X": startPoint.x, "Y": startPoint.y})
|
|
self.commandlist.append(command)
|
|
machinestate.addCommand(command)
|
|
command = Path.Command("G0", {"Z": obj.SafeHeight.Value})
|
|
self.commandlist.append(command)
|
|
machinestate.addCommand(command)
|
|
firstMove = False
|
|
|
|
else: # Use get_linking_moves generator
|
|
linking_moves = linking.get_linking_moves(
|
|
machinestate.getPosition(),
|
|
startPoint,
|
|
obj.ClearanceHeight.Value,
|
|
obj.SafeHeight.Value,
|
|
self.tool,
|
|
solids,
|
|
obj.RetractHeight.Value,
|
|
)
|
|
if len(linking_moves) == 1: # straight move possible. Do nothing.
|
|
pass
|
|
else:
|
|
self.commandlist.extend(linking_moves)
|
|
|
|
# Perform drilling
|
|
dwelltime = obj.DwellTime if obj.DwellEnabled else 0.0
|
|
peckdepth = obj.PeckDepth.Value if obj.PeckEnabled else 0.0
|
|
repeat = 1 # technical debt: Add a repeat property for user control
|
|
chipBreak = obj.chipBreakEnabled and obj.PeckEnabled
|
|
|
|
try:
|
|
drillcommands = drill.generate(
|
|
edge,
|
|
dwelltime,
|
|
peckdepth,
|
|
repeat,
|
|
obj.RetractHeight.Value,
|
|
chipBreak=chipBreak,
|
|
feedRetract=obj.feedRetractEnabled,
|
|
)
|
|
|
|
except ValueError as e: # any targets that fail the generator are ignored
|
|
Path.Log.info(e)
|
|
continue
|
|
|
|
# Set RetractMode annotation for each command
|
|
for command in drillcommands:
|
|
annotations = command.Annotations
|
|
annotations["RetractMode"] = mode
|
|
command.Annotations = annotations
|
|
self.commandlist.append(command)
|
|
# machine.addCommand(command)
|
|
|
|
# Apply feedrates to commands
|
|
PathFeedRate.setFeedRate(self.commandlist, obj.ToolController)
|
|
|
|
def opSetDefaultValues(self, obj, job):
|
|
"""opSetDefaultValues(obj, job) ... set default value for RetractHeight"""
|
|
obj.ExtraOffset = "None"
|
|
obj.KeepToolDown = False # default to safest option: G98
|
|
|
|
if hasattr(job.SetupSheet, "RetractHeight"):
|
|
obj.RetractHeight = job.SetupSheet.RetractHeight
|
|
elif self.applyExpression(obj, "RetractHeight", "StartDepth+SetupSheet.SafeHeightOffset"):
|
|
if not job:
|
|
obj.RetractHeight = 10
|
|
else:
|
|
obj.RetractHeight.Value = obj.StartDepth.Value + 1.0
|
|
|
|
if hasattr(job.SetupSheet, "PeckDepth"):
|
|
obj.PeckDepth = job.SetupSheet.PeckDepth
|
|
elif self.applyExpression(obj, "PeckDepth", "OpToolDiameter*0.75"):
|
|
obj.PeckDepth = 1
|
|
|
|
if hasattr(job.SetupSheet, "DwellTime"):
|
|
obj.DwellTime = job.SetupSheet.DwellTime
|
|
else:
|
|
obj.DwellTime = 1
|
|
|
|
|
|
def SetupProperties():
|
|
setup = []
|
|
setup.append("PeckDepth")
|
|
setup.append("PeckEnabled")
|
|
setup.append("DwellTime")
|
|
setup.append("DwellEnabled")
|
|
setup.append("AddTipLength")
|
|
setup.append("ExtraOffset")
|
|
setup.append("RetractHeight")
|
|
setup.append("KeepToolDown")
|
|
return setup
|
|
|
|
|
|
def Create(name, obj=None, parentJob=None):
|
|
"""Create(name) ... Creates and returns a Drilling operation."""
|
|
if obj is None:
|
|
obj = FreeCAD.ActiveDocument.addObject("Path::FeaturePython", name)
|
|
|
|
obj.Proxy = ObjectDrilling(obj, name, parentJob)
|
|
if obj.Proxy:
|
|
obj.Proxy.findAllHoles(obj)
|
|
|
|
return obj
|