File size: 7,515 Bytes
985c397 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 | # SPDX-License-Identifier: LGPL-2.1-or-later
# ***************************************************************************
# * Copyright (c) 2014 sliptonic <shopinthewoods@gmail.com> *
# * Copyright (c) 2022 - 2025 Larry Woestman <LarryWoestman2@gmail.com> *
# * Copyright (c) 2024 Ondsel <development@ondsel.com> *
# * Copyright (c) 2024 Carl Slater <CandLWorkshopLLC@gmail.com> *
# * *
# * This file is part of the FreeCAD CAx development system. *
# * *
# * 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. *
# * *
# * FreeCAD 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 Lesser General Public License for more details. *
# * *
# * You should have received a copy of the GNU Library General Public *
# * License along with FreeCAD; if not, write to the Free Software *
# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *
# * USA *
# * *
# ***************************************************************************
from typing import Any, Dict
from Path.Post.Processor import PostProcessor
import Path
import FreeCAD
translate = FreeCAD.Qt.translate
DEBUG = False
if DEBUG:
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())
#
# Define some types that are used throughout this file.
#
Values = Dict[str, Any]
class Linuxcnc(PostProcessor):
"""
The LinuxCNC post processor class.
LinuxCNC supports various trajectory control methods (path blending) as
described at https://linuxcnc.org/docs/2.4/html/common_User_Concepts.html#r1_1_2
This post processor implements the following trajectory control methods:
- Exact Path (G61)
- Exact Stop (G64)
- Blend (G61.1)
"""
def __init__(
self,
job,
tooltip=translate("CAM", "LinuxCNC post processor"),
tooltipargs=["blend-mode", "blend-tolerance"],
units="Metric",
) -> None:
super().__init__(
job=job,
tooltip=tooltip,
tooltipargs=tooltipargs,
units=units,
)
Path.Log.debug("LinuxCNC post processor initialized.")
def init_values(self, values: Values) -> None:
"""Initialize values that are used throughout the postprocessor."""
#
super().init_values(values)
#
# Set any values here that need to override the default values set
# in the parent routine.
#
values["ENABLE_COOLANT"] = True
#
# The order of parameters.
#
# linuxcnc doesn't want K properties on XY plane; Arcs need work.
#
values["PARAMETER_ORDER"] = [
"X",
"Y",
"Z",
"A",
"B",
"C",
"I",
"J",
"F",
"S",
"T",
"Q",
"R",
"L",
"H",
"D",
"P",
]
#
# Used in the argparser code as the "name" of the postprocessor program.
#
values["MACHINE_NAME"] = "LinuxCNC"
#
# Any commands in this value will be output as the last commands
# in the G-code file.
#
values[
"POSTAMBLE"
] = """M05
G17 G54 G90 G80 G40
M2"""
values["POSTPROCESSOR_FILE_NAME"] = __name__
#
# Path blending mode configuration (LinuxCNC-specific)
#
values["BLEND_MODE"] = "BLEND" # Options: EXACT_PATH, EXACT_STOP, BLEND
values["BLEND_TOLERANCE"] = 0.0 # P value for BLEND mode (0 = G64, >0 = G64 P-)
#
# Any commands in this value will be output after the header and
# safety block at the beginning of the G-code file.
#
values["PREAMBLE"] = """G17 G54 G40 G49 G80 G90 """
def init_arguments(self, values, argument_defaults, arguments_visible):
"""Initialize command-line arguments, including LinuxCNC-specific options."""
parser = super().init_arguments(values, argument_defaults, arguments_visible)
# Add LinuxCNC-specific argument group
linuxcnc_group = parser.add_argument_group("LinuxCNC-specific arguments")
linuxcnc_group.add_argument(
"--blend-mode",
choices=["EXACT_PATH", "EXACT_STOP", "BLEND"],
default="BLEND",
help="Path blending mode: EXACT_PATH (G61), EXACT_STOP (G61.1), "
"BLEND (G64/G64 P-) (default: BLEND)",
)
linuxcnc_group.add_argument(
"--blend-tolerance",
type=float,
default=0.0,
help="Tolerance for BLEND mode (P value): 0 = no tolerance (G64), "
">0 = tolerance (G64 P-), in current units (default: 0.0)",
)
return parser
def process_arguments(self):
"""Process arguments and update values, including blend mode handling."""
flag, args = super().process_arguments()
if flag and args:
# Update blend mode values from parsed arguments
if hasattr(args, "blend_mode"):
self.values["BLEND_MODE"] = args.blend_mode
if hasattr(args, "blend_tolerance"):
self.values["BLEND_TOLERANCE"] = args.blend_tolerance
# Update PREAMBLE with blend command
blend_cmd = self._get_blend_command()
self.values["PREAMBLE"] += f"\n{blend_cmd}"
return flag, args
def _get_blend_command(self) -> str:
"""Generate the path blending G-code command based on current settings."""
mode = self.values.get("BLEND_MODE", "BLEND")
if mode == "EXACT_PATH":
return "G61"
elif mode == "EXACT_STOP":
return "G61.1"
else: # BLEND
tolerance = self.values.get("BLEND_TOLERANCE", 0.0)
if tolerance > 0:
return f"G64 P{tolerance:.4f}"
else:
return "G64"
# tooltipArgs is inherited from base class and automatically includes
# all arguments from init_arguments() via parser.format_help()
@property
def tooltip(self):
tooltip: str = """
This is a postprocessor file for the CAM workbench.
It is used to take a pseudo-gcode fragment from a CAM object
and output 'real' GCode suitable for a linuxcnc 3 axis mill.
"""
return tooltip
|