add override restore feature feedrate value as config option

Author: ansonl

mfm-configuration-options-setup.md

@@ -94,6 +94,12 @@ A map processed with this set of options will have the following appearance:
 | -------- | ------- | ------- | ------- |
 | `extraPurgePreviousColors` | `[int]` | ≥0 | Tool indices to add extra purging to when that tool is the previous tool in a toolchange. |
 
+### Misc Options
+
+| Key | Value | Cardinality | Description |
+| -------- | ------- | ------- | ------- |
+| `restorePositionFeedrate` | `int` or `-1` | 1 | The feedrate to use when resuming between features. No value or `-1` will use the existing printing state feedrate when resuming. A high feedrate should be used for multi-nozzle printers. Feedrate is in mm/min. |
+
 ### Feature Types (Extrusion Roles)
 
 3D printed Feature Types are different categories used to define printing order and settings of printing travel and extrusion movements.

minimal_toolchanges/prusa-xl-series.gcode

@@ -1,14 +1,15 @@
 ; MFM MINIMAL XL TOOLCHANGE START
-G1 E-15.37656 F2100
-; Filament-specific end gcode
 M104 S70 TYY ; set temperature ;cooldown
+M104 S170 TXX ; start heating up new nozzle
 
-; Change ToolYY -> ToolXX (layer 0)
+G1 E-20 F2100 ; retract
+
+; Change ToolYY -> ToolXX (MFM inserted)
 G1 F21000
-P0 S1 L2 D0
+P0 S1 M1 L2 D0 ; Park tool. Remove M1 to use tool mapping
 ;
 M109 S240 TXX ; YOUR PRINTING TEMP HERE
-TXX S1 L0 D0
+TXX M1 S1 L0 D0 ; Toolchange Remove M1 to use tool mapping
 
 
 M900 K0.05 ; Filament gcode ; YOUR CUSTOM LINEAR ADVANCE K VALUE HERE

premade_options/1to1-multinozzle.json

@@ -0,0 +1,17 @@
+{
+  "modelToRealWorldDefaultUnits": 1,
+  "modelOneToNVerticalScale": 1,
+  "modelSeaLevelBaseThickness": 0,
+  "realWorldIsolineElevationInterval": 10,
+  "realWorldIsolineElevationStart": 5,
+  "realWorldIsolineElevationEnd": 50,
+  "modelIsolineHeight": 1,
+  "isolineColorIndex": 2,
+  "isolineColorFeatureTypes": ["Outer wall", "External perimeter"],
+  "realWorldElevationReplacementColorStart": 30,
+  "realWorldElevationReplacementColorEnd": 60,
+  "replacementColorIndex": 3,
+  "replacementOriginalColorIndex": 0,
+  "extraPurgePreviousColors": [],
+  "restorePositionFeedrate": 24000
+}

sample_models/dual_color_dice/config-dice-test-multinozzle.json

@@ -0,0 +1,17 @@
+{
+  "modelToRealWorldDefaultUnits": 1000,
+  "modelOneToNVerticalScale": 500000,
+  "modelSeaLevelBaseThickness": 0.1,
+  "realWorldIsolineElevationInterval": 500,
+  "realWorldIsolineElevationStart": 200,
+  "realWorldIsolineElevationEnd": 5000,
+  "modelIsolineHeight": 0.5,
+  "isolineColorIndex": 2,
+  "isolineColorFeatureTypes": ["Outer wall", "Inner wall", "External perimeter", "Perimeter"],
+  "realWorldElevationReplacementColorStart": 3650,
+  "realWorldElevationReplacementColorEnd": 9000,
+  "replacementColorIndex": 3,
+  "replacementOriginalColorIndex": 0,
+  "extraPurgePreviousColors": [2],
+  "restorePositionFeedrate": 24000
+}

src/gui.py

@@ -314,6 +314,11 @@ def postProcessTask():
         mfmConfig[CONFIG_REPLACEMENT_COLORS] = replacementColors
         mfmConfig[CONFIG_EXTRA_PURGE_COLORS] = extraPurgePrevColors
         mfmConfig[CONFIG_LINE_ENDING] = lineEndingFlavor.value
+        try:
+          mfmConfig[CONFIG_RESTORE_POSITION_FEEDRATE] = int(userOptions[RESTORE_POSITION_FEEDRATE])
+        except (KeyError, ValueError) as e:
+          print(f"No RESTORE_POSITION_FEEDRATE found in config.")
+          mfmConfig[CONFIG_RESTORE_POSITION_FEEDRATE] = -1
         mfmConfig[CONFIG_APP_NAME] = APP_NAME
         mfmConfig[CONFIG_APP_VERSION] = APP_VERSION
 

src/mfm/app_constants.py

@@ -1,3 +1,3 @@
 APP_NAME_ABBREVIATION = 'MFM'
 APP_NAME = f'3D G-code Map Feature Modifier ({APP_NAME_ABBREVIATION})'
-APP_VERSION = '1.6.8'
+APP_VERSION = '1.6.9'

src/mfm/configuration.py

@@ -26,6 +26,8 @@
 
 EXTRA_PURGE_PREV_COLORS = 'extraPurgePreviousColors'
 
+RESTORE_POSITION_FEEDRATE = 'restorePositionFeedrate'
+
 periodicColorRequiredOptions = [
   MODEL_TO_REAL_WORLD_DEFAULT_UNITS,
   MODEL_ONE_TO_N_VERTICAL_SCALE,

src/mfm/map_post_process.py

@@ -529,7 +529,7 @@ def substituteNewColor(cl, newColorIndex: int):
   return cl
 
 # Write out a new feature
-def startNewFeature(gf: str, ps: PrintState, f: typing.TextIO, out: typing.TextIO, cl: str, toolchangeBareFile: str, pcs: list[PeriodicColor], curFeature: Feature, curFeatureIdx: int):
+def startNewFeature(gf: str, ps: PrintState, f: typing.TextIO, out: typing.TextIO, cl: str, toolchangeBareFile: str, pcs: list[PeriodicColor], curFeature: Feature, curFeatureIdx: int, resFeedrate: int):
   # remember if last line from last feature was supposed to be skipped
   prevFeatureSkip = False
   if ps.skipWrite:
@@ -572,8 +572,10 @@ def startNewFeature(gf: str, ps: PrintState, f: typing.TextIO, out: typing.TextI
       restoreCmd += f" Y{curFeature.startPosition.Y}"
       getattr(curFeature.startPosition, "Z")
       restoreCmd += f" Z{curFeature.startPosition.Z}"
-      getattr(curFeature.startPosition, "F")
-      restoreCmd += f" F{curFeature.startPosition.FTravel}"
+      if resFeedrate == -1:
+        getattr(curFeature.startPosition, "F")
+        resFeedrate = curFeature.startPosition.FTravel
+      restoreCmd += f" F{resFeedrate}"
     except AttributeError as e:
       print(f"Restore position did not find axis {e} yet")
     if len(restoreCmd) > len(MOVEMENT_G0):
@@ -775,7 +777,7 @@ def process(configuration: MFMConfiguration, inputFP: typing.TextIO, outputFP: t
               statusQueue.put(item=item)
 
             f.seek(curFeature.start, os.SEEK_SET) # Seek to the start of top feature in the feature list
-            startNewFeature(configuration[CONFIG_GCODE_FLAVOR], currentPrint, f, out, cl, configuration[CONFIG_TOOLCHANGE_MINIMAL_FILE], configuration[CONFIG_PERIODIC_COLORS], curFeature, curFeatureIdx)
+            startNewFeature(configuration[CONFIG_GCODE_FLAVOR], currentPrint, f, out, cl, configuration[CONFIG_TOOLCHANGE_MINIMAL_FILE], configuration[CONFIG_PERIODIC_COLORS], curFeature, curFeatureIdx, configuration[CONFIG_RESTORE_POSITION_FEEDRATE])
 
         # Start skip if feature.toolchange is reached and we marked feature as needing original toolchange skipped
         if curFeature and curFeature.skipType == SkipType.FEATURE_ORIG_TOOLCHANGE_AND_WIPE_END:

src/mfm/printing_constants.py

@@ -7,6 +7,7 @@
 CONFIG_REPLACEMENT_COLORS = 'CONFIG_REPLACEMENT_COLORS'
 CONFIG_EXTRA_PURGE_COLORS = 'CONFIG_EXTRA_PURGE_COLORS'
 CONFIG_LINE_ENDING = 'CONFIG_LINE_ENDING'
+CONFIG_RESTORE_POSITION_FEEDRATE = 'CONFIG_RESTORE_POSITION_FEEDRATE'
 CONFIG_APP_NAME = 'CONFIG_APP_NAME'
 CONFIG_APP_VERSION = 'CONFIG_APP_VERSION'
 

src/mfm_cmd.py

@@ -171,6 +171,11 @@ def worker():
     mfmConfig[CONFIG_REPLACEMENT_COLORS] = replacementColors
     mfmConfig[CONFIG_EXTRA_PURGE_COLORS] = extraPurgePrevColors
     mfmConfig[CONFIG_LINE_ENDING] = lineEndingFlavor.value
+    try:
+        mfmConfig[CONFIG_RESTORE_POSITION_FEEDRATE] = int(userOptions[RESTORE_POSITION_FEEDRATE])
+    except (KeyError, ValueError) as e:
+        print(f"No RESTORE_POSITION_FEEDRATE found in config.")
+        mfmConfig[CONFIG_RESTORE_POSITION_FEEDRATE] = -1    
     mfmConfig[CONFIG_APP_NAME] = APP_NAME
     mfmConfig[CONFIG_APP_VERSION] = APP_VERSION