kindred/create
1
1
Fork 0
Code Issues 44 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Merge pull request #10509 from LarryWoestman/staging

Browse Source 
Path:  Major refactoring of the export_common function.
This commit is contained in:
sliptonic
2023-10-02 11:26:24 -05:00
committed by GitHub
parent 96efb5814c d534115c19
commit e270f69846
4 changed files with 853 additions and 510 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/Mod/Path/Path/Post/UtilsArguments.py
View File

@@ -504,10 +504,6 @@ def init_shared_values(values):
#
values["RAPID_MOVES"] = ["G0", "G00"]
#
# If True suppress any messages.
#
values["REMOVE_MESSAGES"] = True
#
# Any commands in this value are output after the operation(s)
# and post_operation commands are output but before the
# TOOLRETURN, SAFETYBLOCK, and POSTAMBLE.

480
src/Mod/Path/Path/Post/UtilsExport.py
View File

@@ -29,108 +29,269 @@
import datetime
import os
from typing import Any, Dict, List
import FreeCAD
import Path.Post.Utils as PostUtils
import Path.Post.UtilsParse as PostUtilsParse
import Path.Tool.Controller as PathToolController
#
# This routine processes things in the following order:
#
# OUTPUT_HEADER
# SAFETYBLOCK
# LIST_TOOLS_IN_PREAMBLE
# PREAMBLE
# OUTPUT_BCNC
# SHOW_OPERATION_LABELS
# SHOW_MACHINE_UNITS
# PRE_OPERATION
# ENABLE_COOLANT (coolant on)
# operation(s)
# POST_OPERATION
# ENABLE_COOLANT (coolant off)
# RETURN_TO
# OUTPUT_BCNC
# TOOLRETURN
# SAFETYBLOCK
# POSTAMBLE
# SHOW_EDITOR
#
# The names in all caps may be enabled/disabled/modified by setting
# the corresponding value in the postprocessor.
#
# Define some types that are used throughout this file
Gcode = List[str]
Values = Dict[str, Any]
def export_common(values, objectslist, filename):
"""Do the common parts of postprocessing the objects in objectslist to filename."""
#
nl = "\n"
for obj in objectslist:
if not hasattr(obj, "Path"):
print(
f"The object {obj.Name} is not a path. Please select only path and Compounds."
)
return None
# for obj in objectslist:
# print(obj.Name)
print(f'PostProcessor: {values["POSTPROCESSOR_FILE_NAME"]} postprocessing...')
gcode = ""
# write header
if values["OUTPUT_HEADER"]:
comment = PostUtilsParse.create_comment(values, "Exported by FreeCAD")
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
comment = PostUtilsParse.create_comment(
values, f'Post Processor: {values["POSTPROCESSOR_FILE_NAME"]}'
)
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
if FreeCAD.ActiveDocument:
cam_file = os.path.basename(FreeCAD.ActiveDocument.FileName)
else:
cam_file = "<None>"
comment = PostUtilsParse.create_comment(values, f"Cam File: {cam_file}")
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
comment = PostUtilsParse.create_comment(
values, f"Output Time: {str(datetime.datetime.now())}"
)
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
# Check canned cycles for drilling
def check_canned_cycles(values: Values) -> None:
"""Check canned cycles for drilling."""
if values["TRANSLATE_DRILL_CYCLES"]:
if len(values["SUPPRESS_COMMANDS"]) == 0:
values["SUPPRESS_COMMANDS"] = ["G99", "G98", "G80"]
else:
values["SUPPRESS_COMMANDS"] += ["G99", "G98", "G80"]
for line in values["SAFETYBLOCK"].splitlines(False):
gcode += f"{PostUtilsParse.linenumber(values)}{line}{nl}"
# Write the preamble
if values["OUTPUT_COMMENTS"]:
if values["LIST_TOOLS_IN_PREAMBLE"]:
for item in objectslist:
if hasattr(item, "Proxy") and isinstance(
item.Proxy, PathToolController.ToolController
):
comment = PostUtilsParse.create_comment(
values, f"T{item.ToolNumber}={item.Name}"
)
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
comment = PostUtilsParse.create_comment(values, "Begin preamble")
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
for line in values["PREAMBLE"].splitlines(False):
gcode += f"{PostUtilsParse.linenumber(values)}{line}{nl}"
# verify if PREAMBLE or SAFETYBLOCK have changed MOTION_MODE or UNITS
def determine_coolant_mode(obj) -> str:
"""Determine the coolant mode."""
if (
hasattr(obj, "CoolantMode")
or hasattr(obj, "Base")
and hasattr(obj.Base, "CoolantMode")
):
if hasattr(obj, "CoolantMode"):
return obj.CoolantMode
return obj.Base.CoolantMode
return "None"
def output_coolant_off(values: Values, gcode: Gcode, coolant_mode: str) -> None:
"""Output the commands to turn coolant off if necessary."""
comment: str
nl: str = "\n"
if values["ENABLE_COOLANT"] and coolant_mode != "None":
if values["OUTPUT_COMMENTS"]:
comment = PostUtilsParse.create_comment(
values, f"Coolant Off: {coolant_mode}"
)
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
gcode.append(f"{PostUtilsParse.linenumber(values)}M9{nl}")
def output_coolant_on(values: Values, gcode: Gcode, coolant_mode: str) -> None:
"""Output the commands to turn coolant on if necessary."""
comment: str
nl: str = "\n"
if values["ENABLE_COOLANT"]:
if values["OUTPUT_COMMENTS"] and coolant_mode != "None":
comment = PostUtilsParse.create_comment(
values, f"Coolant On: {coolant_mode}"
)
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
if coolant_mode == "Flood":
gcode.append(f"{PostUtilsParse.linenumber(values)}M8{nl}")
elif coolant_mode == "Mist":
gcode.append(f"{PostUtilsParse.linenumber(values)}M7{nl}")
def output_end_bcnc(values: Values, gcode: Gcode) -> None:
"""Output the ending BCNC header."""
comment: str
nl: str = "\n"
if values["OUTPUT_BCNC"]:
comment = PostUtilsParse.create_comment(values, "Block-name: post_amble")
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
comment = PostUtilsParse.create_comment(values, "Block-expand: 0")
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
comment = PostUtilsParse.create_comment(values, "Block-enable: 1")
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
def output_header(values: Values, gcode: Gcode) -> None:
"""Output the header."""
cam_file: str
comment: str
nl: str = "\n"
if not values["OUTPUT_HEADER"]:
return
comment = PostUtilsParse.create_comment(values, "Exported by FreeCAD")
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
comment = PostUtilsParse.create_comment(
values, f'Post Processor: {values["POSTPROCESSOR_FILE_NAME"]}'
)
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
if FreeCAD.ActiveDocument:
cam_file = os.path.basename(FreeCAD.ActiveDocument.FileName)
else:
cam_file = "<None>"
comment = PostUtilsParse.create_comment(values, f"Cam File: {cam_file}")
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
comment = PostUtilsParse.create_comment(
values, f"Output Time: {str(datetime.datetime.now())}"
)
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
def output_motion_mode(values: Values, gcode: Gcode) -> None:
"""Verify if PREAMBLE or SAFETYBLOCK have changed MOTION_MODE."""
nl: str = "\n"
if "G90" in values["PREAMBLE"] or "G90" in values["SAFETYBLOCK"]:
values["MOTION_MODE"] = "G90"
elif "G91" in values["PREAMBLE"] or "G91" in values["SAFETYBLOCK"]:
values["MOTION_MODE"] = "G91"
else:
gcode += f'{PostUtilsParse.linenumber(values)}{values["MOTION_MODE"]}{nl}'
gcode.append(f'{PostUtilsParse.linenumber(values)}{values["MOTION_MODE"]}{nl}')
def output_postamble_header(values: Values, gcode: Gcode) -> None:
"""Output the postamble header."""
comment: str = ""
nl: str = "\n"
if values["OUTPUT_COMMENTS"]:
comment = PostUtilsParse.create_comment(values, "Begin postamble")
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
def output_postamble(values: Values, gcode: Gcode) -> None:
"""Output the postamble."""
line: str
nl: str = "\n"
for line in values["POSTAMBLE"].splitlines(False):
gcode.append(f"{PostUtilsParse.linenumber(values)}{line}{nl}")
def output_postop(values: Values, gcode: Gcode, obj) -> None:
"""Output the post-operation information."""
comment: str
line: str
nl: str = "\n"
if values["OUTPUT_COMMENTS"]:
comment = PostUtilsParse.create_comment(
values, f'{values["FINISH_LABEL"]} operation: {obj.Label}'
)
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
for line in values["POST_OPERATION"].splitlines(False):
gcode.append(f"{PostUtilsParse.linenumber(values)}{line}{nl}")
def output_preamble(values: Values, gcode: Gcode) -> None:
"""Output the preamble."""
comment: str
line: str
nl: str = "\n"
if values["OUTPUT_COMMENTS"]:
comment = PostUtilsParse.create_comment(values, "Begin preamble")
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
for line in values["PREAMBLE"].splitlines(False):
gcode.append(f"{PostUtilsParse.linenumber(values)}{line}{nl}")
def output_preop(values: Values, gcode: Gcode, obj) -> None:
"""Output the pre-operation information."""
comment: str
line: str
nl: str = "\n"
if values["OUTPUT_COMMENTS"]:
if values["SHOW_OPERATION_LABELS"]:
comment = PostUtilsParse.create_comment(
values, f"Begin operation: {obj.Label}"
)
else:
comment = PostUtilsParse.create_comment(values, "Begin operation")
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
if values["SHOW_MACHINE_UNITS"]:
comment = PostUtilsParse.create_comment(
values, f'Machine units: {values["UNIT_SPEED_FORMAT"]}'
)
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
if values["OUTPUT_MACHINE_NAME"]:
comment = PostUtilsParse.create_comment(
values,
f'Machine: {values["MACHINE_NAME"]}, {values["UNIT_SPEED_FORMAT"]}',
)
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
for line in values["PRE_OPERATION"].splitlines(False):
gcode.append(f"{PostUtilsParse.linenumber(values)}{line}{nl}")
def output_return_to(values: Values, gcode: Gcode) -> None:
"""Output the RETURN_TO command."""
cmd: str
nl: str = "\n"
num_x: str
num_y: str
num_z: str
if values["RETURN_TO"]:
num_x = values["RETURN_TO"][0]
num_y = values["RETURN_TO"][1]
num_z = values["RETURN_TO"][2]
cmd = PostUtilsParse.format_command_line(
values, ["G0", f"X{num_x}", f"Y{num_y}", f"Z{num_z}"]
)
gcode.append(f"{PostUtilsParse.linenumber(values)}{cmd}{nl}")
def output_safetyblock(values: Values, gcode: Gcode) -> None:
"""Output the safety block."""
line: str
nl: str = "\n"
for line in values["SAFETYBLOCK"].splitlines(False):
gcode.append(f"{PostUtilsParse.linenumber(values)}{line}{nl}")
def output_start_bcnc(values: Values, gcode: Gcode, obj) -> None:
"""Output the starting BCNC header."""
comment: str
nl: str = "\n"
if values["OUTPUT_BCNC"]:
comment = PostUtilsParse.create_comment(values, f"Block-name: {obj.Label}")
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
comment = PostUtilsParse.create_comment(values, "Block-expand: 0")
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
comment = PostUtilsParse.create_comment(values, "Block-enable: 1")
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
def output_tool_list(values: Values, gcode: Gcode, objectslist) -> None:
"""Output a list of the tools used in the objects."""
comment: str
nl: str = "\n"
if values["OUTPUT_COMMENTS"] and values["LIST_TOOLS_IN_PREAMBLE"]:
for item in objectslist:
if hasattr(item, "Proxy") and isinstance(
item.Proxy, PathToolController.ToolController
):
comment = PostUtilsParse.create_comment(
values, f"T{item.ToolNumber}={item.Name}"
)
gcode.append(f"{PostUtilsParse.linenumber(values)}{comment}{nl}")
def output_tool_return(values: Values, gcode: Gcode) -> None:
"""Output the tool return block."""
line: str
nl: str = "\n"
for line in values["TOOLRETURN"].splitlines(False):
gcode.append(f"{PostUtilsParse.linenumber(values)}{line}{nl}")
def output_units(values: Values, gcode: Gcode) -> None:
"""Verify if PREAMBLE or SAFETYBLOCK have changed UNITS."""
nl: str = "\n"
if "G21" in values["PREAMBLE"] or "G21" in values["SAFETYBLOCK"]:
values["UNITS"] = "G21"
values["UNIT_FORMAT"] = "mm"
@@ -140,132 +301,79 @@ def export_common(values, objectslist, filename):
values["UNIT_FORMAT"] = "in"
values["UNIT_SPEED_FORMAT"] = "in/min"
else:
gcode += f'{PostUtilsParse.linenumber(values)}{values["UNITS"]}{nl}'
gcode.append(f'{PostUtilsParse.linenumber(values)}{values["UNITS"]}{nl}')
def export_common(values: Values, objectslist, filename: str) -> str:
"""Do the common parts of postprocessing the objects in objectslist to filename."""
coolant_mode: str
dia: PostUtils.GCodeEditorDialog
final: str
gcode: Gcode = []
result: bool
for obj in objectslist:
if not hasattr(obj, "Path"):
print(f"The object {obj.Name} is not a path.")
print("Please select only path and Compounds.")
return ""
print(f'PostProcessor: {values["POSTPROCESSOR_FILE_NAME"]} postprocessing...')
check_canned_cycles(values)
output_header(values, gcode)
output_safetyblock(values, gcode)
output_tool_list(values, gcode, objectslist)
output_preamble(values, gcode)
output_motion_mode(values, gcode)
output_units(values, gcode)
for obj in objectslist:
# Skip inactive operations
if hasattr(obj, "Active") and not obj.Active:
continue
if hasattr(obj, "Base") and hasattr(obj.Base, "Active") and not obj.Base.Active:
continue
coolant_mode = determine_coolant_mode(obj)
output_start_bcnc(values, gcode, obj)
output_preop(values, gcode, obj)
output_coolant_on(values, gcode, coolant_mode)
# output the G-code for the group (compound) or simple path
PostUtilsParse.parse_a_group(values, gcode, obj)
output_postop(values, gcode, obj)
output_coolant_off(values, gcode, coolant_mode)
# do the pre_op
if values["OUTPUT_BCNC"]:
comment = PostUtilsParse.create_comment(values, f"Block-name: {obj.Label}")
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
comment = PostUtilsParse.create_comment(values, "Block-expand: 0")
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
comment = PostUtilsParse.create_comment(values, "Block-enable: 1")
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
if values["OUTPUT_COMMENTS"]:
if values["SHOW_OPERATION_LABELS"]:
comment = PostUtilsParse.create_comment(
values, f"Begin operation: {obj.Label}"
)
else:
comment = PostUtilsParse.create_comment(values, "Begin operation")
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
if values["SHOW_MACHINE_UNITS"]:
comment = PostUtilsParse.create_comment(
values, f'Machine units: {values["UNIT_SPEED_FORMAT"]}'
)
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
if values["OUTPUT_MACHINE_NAME"]:
comment = PostUtilsParse.create_comment(
values,
f'Machine: {values["MACHINE_NAME"]}, {values["UNIT_SPEED_FORMAT"]}',
)
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
for line in values["PRE_OPERATION"].splitlines(False):
gcode += f"{PostUtilsParse.linenumber(values)}{line}{nl}"
output_return_to(values, gcode)
#
# This doesn't make sense to me. It seems that both output_start_bcnc and
# output_end_bcnc should be in the for loop or both should be out of the
# for loop. However, that is the way that grbl post code was written, so
# for now I will leave it that way until someone has time to figure it out.
#
output_end_bcnc(values, gcode)
output_postamble_header(values, gcode)
output_tool_return(values, gcode)
output_safetyblock(values, gcode)
output_postamble(values, gcode)
# get coolant mode
coolantMode = "None"
if (
hasattr(obj, "CoolantMode")
or hasattr(obj, "Base")
and hasattr(obj.Base, "CoolantMode")
):
if hasattr(obj, "CoolantMode"):
coolantMode = obj.CoolantMode
else:
coolantMode = obj.Base.CoolantMode
# turn coolant on if required
if values["ENABLE_COOLANT"]:
if values["OUTPUT_COMMENTS"] and coolantMode != "None":
comment = PostUtilsParse.create_comment(
values, f"Coolant On: {coolantMode}"
)
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
if coolantMode == "Flood":
gcode += f"{PostUtilsParse.linenumber(values)}M8{nl}"
elif coolantMode == "Mist":
gcode += f"{PostUtilsParse.linenumber(values)}M7{nl}"
# process the operation gcode
gcode += PostUtilsParse.parse_a_group(values, obj)
# do the post_op
if values["OUTPUT_COMMENTS"]:
comment = PostUtilsParse.create_comment(
values, f'{values["FINISH_LABEL"]} operation: {obj.Label}'
)
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
for line in values["POST_OPERATION"].splitlines(False):
gcode += f"{PostUtilsParse.linenumber(values)}{line}{nl}"
# turn coolant off if required
if values["ENABLE_COOLANT"] and coolantMode != "None":
if values["OUTPUT_COMMENTS"]:
comment = PostUtilsParse.create_comment(
values, f"Coolant Off: {coolantMode}"
)
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
gcode += f"{PostUtilsParse.linenumber(values)}M9{nl}"
if values["RETURN_TO"]:
num_x = values["RETURN_TO"][0]
num_y = values["RETURN_TO"][1]
num_z = values["RETURN_TO"][2]
gcode += f"{PostUtilsParse.linenumber(values)}G0 X{num_x} Y{num_y} Z{num_z}{nl}"
# do the post_amble
if values["OUTPUT_BCNC"]:
comment = PostUtilsParse.create_comment(values, "Block-name: post_amble")
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
comment = PostUtilsParse.create_comment(values, "Block-expand: 0")
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
comment = PostUtilsParse.create_comment(values, "Block-enable: 1")
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
if values["OUTPUT_COMMENTS"]:
comment = PostUtilsParse.create_comment(values, "Begin postamble")
gcode += f"{PostUtilsParse.linenumber(values)}{comment}{nl}"
for line in values["TOOLRETURN"].splitlines(False):
gcode += f"{PostUtilsParse.linenumber(values)}{line}{nl}"
for line in values["SAFETYBLOCK"].splitlines(False):
gcode += f"{PostUtilsParse.linenumber(values)}{line}{nl}"
for line in values["POSTAMBLE"].splitlines(False):
gcode += f"{PostUtilsParse.linenumber(values)}{line}{nl}"
final = "".join(gcode)
if FreeCAD.GuiUp and values["SHOW_EDITOR"]:
final = gcode
if len(gcode) > 100000:
if len(final) > 100000:
print("Skipping editor since output is greater than 100kb")
else:
dia = PostUtils.GCodeEditorDialog()
dia.editor.setText(gcode)
dia.editor.setText(final)
result = dia.exec_()
if result:
final = dia.editor.toPlainText()
else:
final = gcode
print("done postprocessing.")
if not filename == "-":
with open(filename, "w", newline=values["END_OF_LINE_CHARACTERS"]) as gfile:
with open(
filename, "w", encoding="utf-8", newline=values["END_OF_LINE_CHARACTERS"]
) as gfile:
gfile.write(final)
return final

875
src/Mod/Path/Path/Post/UtilsParse.py
View File

File diff suppressed because it is too large Load Diff

4
src/Mod/Path/Path/Post/scripts/refactored_centroid_post.py
View File

@@ -131,10 +131,6 @@ def init_values(values):
#
values["PREAMBLE"] = """G53 G00 G17"""
#
# Output any messages.
#
values["REMOVE_MESSAGES"] = False
#
# Any commands in this value are output after the header but before the preamble,
# then again after the TOOLRETURN but before the POSTAMBLE.
#