Merge pull request #282 from ArmoredTurtle/DEV

Merging DEV changes into main

Author: MG-longshot

CHANGELOG.md

@@ -5,18 +5,157 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2025-03-17]
+### Added
+- Added `SET_SPEED_MULTIPLIER` macro to allow user to change fwd/rwd speed multipliers during prints
+- Added `SAVE_SPEED_MULTIPLIER` macro to save updated multiplier to config file for specified lane
+
+### Fixed
+- Added check to AFC pause/resume functions to make sure printer was not paused/paused before doing any actions
+- Fixed issue where macro variables were not passed from AFC_PAUSE/AFC_RESUME to PAUSE/RESUME macros if user passed in variables when calling these macros  
+
+## [2025-03-12]
+### Added
+- Virtual bypass sensor, AFC adds this sensor if hardware bypass is not detected
+
+### Fixed
+- Issue where z would move back down when calling cut macro after z hop from AFC
+
+## [2025-03-10]
+### Added
+- Reporting error messages in AFC status so they can be shown in AFC integration panel
+
+### Fixed
+- Issue where resuming position could crash into object/purge tower
+- Issue where creating filament_switch_sensor in AFC would cause klipper to error out when AFC include is before `[pause_resume]` and user has `recover_velocity` defined
+- Issue where passing in `+-<number>` for length when calling `SET_BOWDEN_LENGTH` would crash klipper 
+
+## [2025-03-07]
+### Added
+- Added variable_z_purge_move to Poop macro. Setting this to False will allow pooping with no z movement
+- Added variable_z_move to brush macro. this value will set a positive Z move at the end of the brush to move the nozzle away from the brush
+
+### Fixed
+- Fixed error that occurs when all lanes are calibrated
+
+## [2025-03-07]
+### Added
+- Added error checking to spool runout, before if a error happened during unload it could keep running the print
+- Added lane ejection when runout detected but rollover not setup
+- Added AFC_PAUSE function to override users pause macro so that necessary measures could be added to move in Z to avoid
+  hitting part if users pause macro moves toolhead
+- Added `afc_unload_bowden_length` parameter
+- Added moving Z to previous saved position +z hop when resuming to avoid hitting part when moving back
+
+### Fixed
+- Fixed error when trying to turn of LEDs
+- Fixed saving position as it was not saving correctly
+- Reworked rollover logic to restore position after lane has been ejected fully so that nozzle does not sit
+  on part while ejecting spool
+- Fixed error where user could put wrong lane for rollover and it would not error until runout logic is triggered
+- Fixed errors found in calibration routines
+
+
+## [2025-03-02]
+
+### Fixed
+- Fixed calibration to error out at excessive distances
+    - Calibration uses default config values plus fixed distances to be able to error out distances
+
+## [2025-02-28]
+
+### Added
+- Logging of delta time and total time for how long toolchanges take
+- Logging for AFC now logs to AFC.log file
+- Ability to turn off/on AFC leds with `TURN_OFF_AFC_LED`/`TURN_ON_AFC_LED`
+- `default_material_type` variable to assign to spool when loaded into lane
+- `pause_when_bypass_active` variable to pause print if bypass is active, defaults to false
+- `unload_on_runout variable` to unload lane when runout happens and another lane is not setup to change to, default to false
+- Updated calibration to use buffer as tool_pin_start if only tool_pin_end is defined and buffer is also defined
+- Ability to change tool_stn/tool_stn_unload/tool_sensor_after_extruder without restarting
+
+### Fixed
+- Issue where filament was not unloading correctly when only tool_pin_end is defined
+- Issue where prep logic would try to unload forever if only tool_pin_end was defined
+
+## [2025-02-25]
+
+### Fixed
+
+- Tip forming was multiplying all speeds with a factor of 60 by mistake. Existing configuration might need to be adapted
+  to compensate for this fix.
+
 ## [2025-02-23]
 
+### Added
+- Checking to make sure lane was not None in cmd_CHANGE_TOOL
+- Pauses in TOOL_LOAD/TOOL_UNLOAD/CHANGE_TOOL for early returns if printer is currently in a print
+
+### Changed
+- The `install-afc.sh` script will now check for a supported version of python and fail the installation if it is not present.
+
+### Fixed
+- Error in cmd_CHANGE_TOOL where change logic was being triggered if change was in a comment on the same line
+- Turned runout pause message into error message which also pauses printer
+- Error where infinite spool would crash klipper when calling change tool
+
+## [2025-02-20]
+
+### Added
+
+- Users are now able to specify a non default moonraker address when using the `install-afc.sh` script. This value defaults to `http://localhost` but
+can be adjusted for cases such as a remote moonraker installation, https, etc. This value can be set during the installation process by using the `-a <address>` flag.
+
+## [2025-02-19]
+
+### Added
+- Clearing error_state when print starts, before this could be set before printing and would cause AFC to not save/restore position
+- Added 1 second time debounce to prep callback
+- Added abs function when determining speed for LANE_MOVE macro
+
 ### Changed
-- The `install-afc.sh` script will now check for a supported version of python and fail the installation if it is not present. 
+- Updated error print out messages when loading/unloading
+- The way error messages printed out so they are grouped together
+
+### Fixed
+- Issue where getting spoolman data would error out when server variable in moonraker ended in a slash
+- Issue where prep would no longer activate extruder motors when user rapidely triggered prep sensor
 
 ## [2025-02-17]
 
 ### Changed
 - Updated the `install-afc.sh` script to prompt the user to install dependencies if they are not already installed instead of installing them automatically.
 
+## [2025-02-16]
+
+### Added
+- Ability to manually set and unset lanes that are loaded in toolhead
+- Braking to n20 when stopping them. This was advised to implement from Isik to hopefully help reduce backfeeding from motors into MCU board when in coast mode
+- Default temperature value to default_material_temps list instead of using min_temp_val + 5
+- Check for printing for LANE_MOVE, HUB_LOAD and LANE_UNLOAD macros
+- Variable for prep done so save_vars function is not called before running prep function which would override the variables file before PREP could run
+- More guidance to error messages when errors happen during TOOL_LOAD and TOOL_UNLOAD
+- Helper function to get loaded lane for current extruder, help move the code towards working with multiple extruders
+- Debounce logic when triggering prep sensor so that it does not run more than once
+- Variable speed to LANE_MOVE move, run faster for distance over 200
+- Printout when trying to load and load sensor is already triggered
+- More printout to let user know when calibration is done
+- Printout when trying to unload but no lane is loaded
+
+### Changed
+- Updated documentation
+
+### Fixed
+- Error in prep when there are multiple extruders
+- Error when hub was not defined
+
 ## [2025-02-13]
 
+### Added
+- Assisted unload  
+  When enabled, the retracts out of the toolhead before the long, fast move back throught the bowden tube is assisted.
+  This helps with full spools where even a retract of a few centimeters can cause a loop to fall off the spool.
+
 ### Changed
 - The `install-afc.sh` install script will now remove the `AFC.var.tool` file if detected as it is no longer needed.
 

README.md

@@ -63,7 +63,7 @@ Once the plugin is updated, please uncomment the lines in your `printer.cfg` fil
 
 The `install-afc.sh` script will automatically install the majority of the plugin for you.
 
-Prior to starting Klipper, please review the configuration located at `~/printer_data/config/AFC/AFC_Hardware.cfg` and ensure all pins are correct for your specific hardware.
+Prior to starting Klipper, please review the configuration located at `~/printer_data/config/AFC/AFC_Turtle_(n).cfg` and ensure all pins are correct for your specific hardware.
 
 Additionally, review the following files for any changes that may be required:
 
@@ -121,7 +121,7 @@ Prior to operation, the following checks / updates **MUST** be made to your syst
 1.  Update the following values in the `~/printer_data/config/AFC/AFC_Hardware-{board}.cfg` file:  
     *default name with AFC-lite will be AFC_Hardware-AFC.cfg*
 
-    - tool_stn: This value is the length from your toolhead sensor to nozzle
+    - tool_stn: This value is the length from your toolhead sensor to nozzle, if `tool_end` is defined then distance is from this sensor
     - tool_stn_unload: This value is the amount to unload from extruder when doing a filament change.
 
 2.  Update the following in the `~/printer_data/config/AFC/AFC_Turtle_{n}.cfg` file:  
@@ -294,7 +294,7 @@ Debug information about the respooler system can be found by visiting the follow
 
 ## LEDs not displaying correct color
 
-If your leds are not displaying the correct color update the following value under your `AFC_led` section in `~/printer_data/config/AFC/AFC_hardware.cfg` file.
+If your leds are not displaying the correct color update the following value under your `AFC_led` section in `~/printer_data/config/AFC/AFC_Turtle_(n).cfg` file.
 
 - color_order: change to match the color order for you leds. Different color orders are: RGB, RGBW, GRB, GRBW
 

config/AFC.cfg

@@ -12,22 +12,29 @@ short_moves_speed: 50           # mm/s. Default value is 50mm/s.
 short_moves_accel: 300          # mm/s². Default value is 300mm/s².
 short_move_dis: 10              # Move distance for failsafe moves. Default is 10mm.
 
-# global_print_current: 0.6     # Uncomment to set stepper motors to a lower current while printing
+#global_print_current: 0.6       # Uncomment to set stepper motors to a lower current while printing
                                 # This value can also be set per stepper with print_current: 0.6
-# enable_sensors_in_gui: True    # Uncomment to show all sensor switches as filament sensors in mainsail/fluidd gui
-                                 # this can also be set at individual levels in your config file
-default_material_temps: PLA:210, ABS:235, ASA:235 # Default temperature to set extruder when loading/unloading lanes.
+enable_sensors_in_gui: True     # Uncomment to show all sensor switches as filament sensors in mainsail/fluidd gui
+                                # this can also be set at individual levels in your config file
+default_material_temps: default: 235, PLA:210, ABS:235, ASA:235 # Default temperature to set extruder when loading/unloading lanes.
                                                   # Material needs to be either manually set or uses material from spoolman if extruder temp is not
                                                   # set in spoolman. Follow current format to add more
+#default_material_type: PLA      # Default material type to assign to a spool once loaded into a lane
+
 load_to_hub: True               # Fast loads filament to hub when inserted, set to False to disable. This is a global setting and can be overridden at AFC_stepper
-# moonraker_port: 7125            # Port to connect to when interacting with moonraker. Used when there are multiple moonraker/klipper instances on a single host
+#moonraker_port: 7125            # Port to connect to when interacting with moonraker. Used when there are multiple moonraker/klipper instances on a single host
+
+assisted_unload: True           # If True, the unload retract is assisted to prevent loose windings, especially on full spools. This can prevent loops from slipping off the spool. This is a global setting and can be overridden at the unit and stepper level.
+#pause_when_bypass_active: True  # When True AFC pauses print when change tool is called and bypass is loaded
+#unload_on_runout: True          # When True AFC will unload lane and then pause when runout is triggered and spool to swap to is not set(infinite spool)
+#debug: True                     # Setting to True turns on more debugging to show on console
 
 #--=================================================================================-
 #------- TRSYNC Values --------------------------------------------------------------
 #--=================================================================================-
-# trsync_update: True           # Uncomment this value to update Klipper's trsync value automatically
-# trsync_timeout: 0.05          # Uncomment this value if timeout needs to be greater than the default of 0.05
-# trsync_single_timeout: 0.250  # Uncomment this value if single_timeout needs to be greater than the default of 0.250
+#trsync_update: True           # Uncomment this value to update Klipper's trsync value automatically
+#trsync_timeout: 0.05          # Uncomment this value if timeout needs to be greater than the default of 0.05
+#trsync_single_timeout: 0.250  # Uncomment this value if single_timeout needs to be greater than the default of 0.250
 
 #--=================================================================================-
 #------- Pause/Resume ---------------------------------------------------------------

config/AFC_Macro_Vars.cfg

@@ -119,6 +119,7 @@ gcode: # Leave empty
 
 variable_purge_loc_xy             : -1, -1    # (x,y) Location of where to purge
 variable_purge_spd                : 6.5       # Speed, in mm/s, of the purge.
+variable_z_purge_move             : True      # Set to False to not move in Z during poop
 
 # Speed, in mm/s to lift z after the purge is completed. Its a faster lift to keep it from 
 # sticking to the toolhead
@@ -193,6 +194,9 @@ variable_brush_depth              : 10        # Total depth in mm of the brush i
 variable_y_brush                  : True      # True - Brush along Y axis first then X. False - Only brush along x
 variable_brush_count              : 4         # Number of passes to make on the brush.
 
+# Move in Z after brush to avoid bed if brush is at Z0 (Set z to -1 if you dont want a z move)
+variable_z_move                   : -1
+
 
 #--=================================================================================-
 #------- Park ----------------------------------------------------------------------

config/macros/Brush.cfg

@@ -1,19 +1,20 @@
 [gcode_macro AFC_BRUSH]
 description: Wipe the nozzle on the brush
 gcode:
-    {% set gVars = printer['gcode_macro _AFC_GLOBAL_VARS'] %}
-    {% set accel = gVars['accel']|float %}
-    {% set travel_speed = gVars['travel_speed'] * 60|float %}
-    {% set z_travel_speed = gVars['z_travel_speed'] * 60|float %}
-    {% set verbose = gVars['verbose']|int %}
-    {% set vars = printer['gcode_macro _AFC_BRUSH_VARS'] %}
-    {% set Bx, By, Bz = vars.brush_loc|map('float') %}
+    {% set gVars             = printer['gcode_macro _AFC_GLOBAL_VARS'] %}
+    {% set accel             = gVars['accel']|float %}
+    {% set travel_speed      = gVars['travel_speed'] * 60|float %}
+    {% set z_travel_speed    = gVars['z_travel_speed'] * 60|float %}
+    {% set verbose           = gVars['verbose']|int %}
+    {% set vars              = printer['gcode_macro _AFC_BRUSH_VARS'] %}
+    {% set Bx, By, Bz        = vars.brush_loc|map('float') %}
     {% set brush_clean_accel = vars['brush_clean_accel']|float %}
-    {% set y_brush = vars['y_brush']|default(false)|lower == 'true' %}
+    {% set y_brush           = vars['y_brush']|default(false)|lower == 'true' %}
     {% set brush_clean_speed = vars['brush_clean_speed'] * 60|float %}
-    {% set brush_width = vars['brush_width']|float %}
-    {% set brush_depth = vars['brush_depth']|float %}
-    {% set brush_count = vars['brush_count']|int %}
+    {% set brush_width       = vars['brush_width']|float %}
+    {% set brush_depth       = vars['brush_depth']|float %}
+    {% set brush_count       = vars['brush_count']|int %}
+    {% set z_move            = vars['z_move']     |float %}
 
     # Get printer bounds to make sure none of our cleaning moves fall outside of them
     {% set x_max = printer.toolhead.axis_maximum.x %}
@@ -47,6 +48,8 @@ gcode:
     {% if verbose > 1 %}
       RESPOND TYPE=command MSG='AFC_Brush: Move to Brush.'
     {% endif %}
+
+    G90
 
     G1 X{Bx} Y{By} F{travel_speed}
 
@@ -91,5 +94,16 @@ gcode:
 
     {% endfor %}
 
+    {% if z_move >= 0 %}
+      {% if verbose > 1 %}
+        RESPOND TYPE=command MSG='AFC_Brush: Finish z_move.'
+      {% endif %}
+      G91
+      G1 Z{z_move} F{z_travel_speed}
+      G90
+    {% endif %}
+
+    G90
+
     # Reset acceleration values to what it was before
     SET_VELOCITY_LIMIT ACCEL={saved_accel}

config/macros/Park.cfg

@@ -24,5 +24,7 @@ gcode:
     RESPOND TYPE=command MSG='AFC_Park: Park Toolhead'
   {% endif %}
 
+  G90
+
   G1 Z{z_safe} F{z_travel_speed}
   G1 X{Px} Y{Py} F{travel_speed}