Merge pull request #524 from ArmoredTurtle/DEV for Release v1.0.29

Release v1.0.29

Author: jimmyjon711

CHANGELOG.md

@@ -5,6 +5,50 @@ 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-08-30]
+### Added
+- Catch for JSON decode error when trying to read and load AFC.var.unit file
+
+### Fixes
+- Issue where TMC section search would error out if not defined. Search is now gated behind user enabling print_current variable. If a user is using a different driver, like a4988 for example, AFC will not error out as long as print_current variable is not defined.
+
+## [2025-08-24]
+### Added
+- You can now use the `install-afc.sh` script to delete the `AFC.var.unit` file if necessary. This option is located under
+  the `Utilities` menu.
+
+### Fixed
+- Issue where HTLF unit would not select lane and sync with extruder when running prep
+
+## [2025-08-22]
+### Added
+- Added a new command to test lane loading and unloading in an automated and random fashion (`AFC_TEST_LANES`). Please
+  see the documentation for more information on how to use this command and it's various options.
+- Option to delay/debounce switches. Debounce delay is defaulted to zero but can be updated globally by adding `debounce_delay: <delay_value>`
+  to AFC config section. Or this value can be added per AFC_extruder, AFC_hub, AFC_stepper/AFC_lane configs. Runout can be also disabled by
+  turning off filament switch in gui, if PREP sensor is disabled this will also disable infinite spool rollover. When klipper is restarted
+  all switches will be enabled again.
+
+## [2025-08-17]
+### Added
+- Servo option to brush macro.
+
+## [2025-08-10]
+### Fixed
+- A negative `afc_unload_bowden_length` is no longer able to be set by the calibration routine. 
+
+## [2025-08-06]
+### Fixed
+- The `install-afc.sh` script will no longer tell you it removed the `velocity` setting if it didn't exist.
+
+## [2025-07-30]
+### Fixed
+- Updated the `SET_MAP` command to correctly handle `MAP` parameters in either upper or lower case text. 
+
+## [2025-07-27]
+### Updated
+- The `install-afc.sh` script will now only copy relevant MCU files when installing a new unit. 
+
 ## [2025-07-20]
 ### Added
 - Software defined physical buttons are now available and supported. See documentation for more information on how to set them up.

config/AFC_Macro_Vars.cfg

@@ -38,7 +38,7 @@ variable_cut_accel                : 0
 variable_cut_direction            : "left"
 
 # This distance is used to move toolhead to cut filament
-# and to create a small saftely distance that aids in generating momentum
+# and to create a small safety distance that aids in generating momentum
 variable_pin_park_dist            : 6.0       # Distance in mm
 
 # Position of the toolhead when the cutter is fully compressed.
@@ -93,7 +93,7 @@ variable_pushback_dwell_time      : 20        # Time to dwell between the pushba
 variable_safe_margin_xy           : 30, 30    # Approx toolhead width +5mm, height +5mm)
 
 # Some printers may need a boost of power to complete the cut without skipping steps.
-# One option is to increase the current for thost steppers in printer.cfg. Another
+# One option is to increase the current for the steppers in printer.cfg. Another
 # option is to use these variables to set a current that is only used during the
 # cut motion. Different combinations of kinematics and cutter configurations engage
 # different combinations of steppers for that motion.  Set the needed variables.
@@ -208,6 +208,12 @@ variable_brush_count              : 4         # Number of passes to make on the
 # 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
 
+# Addon variables for brush servo control
+#variable_tool_servo_enable        : False
+#variable_tool_servo_name          : "tool_brush"
+#variable_tool_servo_angle_out     : 115
+#variable_tool_servo_angle_in      : 0
+
 
 #--=================================================================================-
 #------- Park ----------------------------------------------------------------------
@@ -221,4 +227,4 @@ variable_park_loc_xy              : -1, -1    # Position to park the toolhead
 variable_z_hop                    : 0         # Height to raise Z when moving to park. Leave 0 to disable
 variable_park_z                   : 0         # Absolute height to lower to after park move.  Leave 0 to disable
                                               # This is intended to be used to reduce oozing during loading / unload right before a poop.
-                                              # Typically this would be set at the variable_purge_start value when needed.
+                                              # Typically this would be set at the variable_purge_start value when needed.

config/macros/Brush.cfg

@@ -15,6 +15,7 @@ gcode:
     {% set brush_depth       = vars['brush_depth']      | default(10)        | float %}
     {% set brush_count       = vars['brush_count']      | default(4)         | int %}
     {% set z_move            = vars['z_move']           | default(-1)        | float %}
+    {% set tool_servo_enable = vars['tool_servo_enable']|default(false)      | lower == 'true' %}
 
     # Get printer bounds to make sure none of our cleaning moves fall outside of them
     # Check for IDEX
@@ -56,6 +57,15 @@ gcode:
 
     SET_VELOCITY_LIMIT ACCEL={selected_accel}
 
+    # Extend servo if enabled
+    {% if tool_servo_enable %}
+        {% if verbose > 1 %}
+          RESPOND TYPE=command MSG='Brush Servo Extended'
+        {% endif %}
+        # Extend brush servo
+        _BRUSH_SERVO POS=out
+    {% endif %}
+
     {% if verbose > 0 %}
       RESPOND TYPE=command MSG='AFC_Brush: Clean Nozzle'
     {% endif %}
@@ -121,7 +131,36 @@ gcode:
 
     G90
 
+    # Retract servo if enabled
+    {% if tool_servo_enable %}
+        {% if verbose > 1 %}
+          RESPOND TYPE=command MSG='Brush Servo Retracted'
+        {% endif %}
+        # Retract brush servo
+        _BRUSH_SERVO POS=in
+    {% endif %}
+
     # Reset acceleration values to what it was before
     SET_VELOCITY_LIMIT ACCEL={saved_accel}
 
     AFC_ENABLE_SKEW
+
+#--=================================================================================-
+#------- Helper macro for brush servo -----------------------------------------------
+#--=================================================================================-
+[gcode_macro _BRUSH_SERVO]
+# Increase this value (in milliseconds) if the servo doesn't have enough time to fully retract or extend
+variable_dwell_time: 200
+gcode:
+  {% set c1 = printer['gcode_macro _AFC_BRUSH_VARS'] %}
+  {% set pos = params.POS %}
+  {% if pos == "in" %}
+    SET_SERVO SERVO={c1.tool_servo_name} ANGLE={c1.tool_servo_angle_in}
+    G4 P{dwell_time}
+  {% elif pos == "out" %}
+    SET_SERVO SERVO={c1.tool_servo_name} ANGLE={c1.tool_servo_angle_out}
+    G4 P{dwell_time}
+  {% else %}
+    {action_respond_info("Brush Servo: provide POS=[in|out]")}
+  {% endif %}
+  SET_SERVO SERVO={c1.tool_servo_name} WIDTH=0

extras/AFC.py

@@ -27,7 +27,7 @@
 try: from extras.AFC_stats import AFCStats
 except: raise error(ERROR_STR.format(import_lib="AFC_stats", trace=traceback.format_exc()))
 
-AFC_VERSION="1.0.26"
+AFC_VERSION="1.0.29"
 
 # Class for holding different states so its clear what all valid states are
 class State:
@@ -121,10 +121,11 @@ def __init__(self, config):
         self.common_density_values  = config.getlists("common_density_values",
                                                       ("PLA:1.24", "PETG:1.23", "ABS:1.04", "ASA:1.07"))
         self.common_density_values  = list(self.common_density_values)
+        self.test_extrude_amt       = config.get('test_extrude_amt', 10)
 
         #LED SETTINGS
         self.ind_lights = None
-        # led_name is not used, either use or needs to be removed, removing this would break everyones config as well
+        # led_name is not used, either use or needs to be removed, removing this would break everyone's config as well
         self.led_name               = config.get('led_name',None)
         self.led_off                = "0,0,0,0"
         self.led_fault              = config.get('led_fault','1,0,0,0')             # LED color to set when faults occur in lane        (R,G,B,W) 0 = off, 1 = full brightness.
@@ -195,6 +196,9 @@ def __init__(self, config):
         self.enable_assist          = config.getboolean("enable_assist",        True)
         # Weight spool has to be below to activate print assist
         self.enable_assist_weight   = config.getfloat("enable_assist_weight",   500.0)
+        self.enable_hub_runout      = config.getboolean("enable_hub_runout",    True)
+        self.enable_tool_runout     = config.getboolean("enable_tool_runout",   True)
+        self.debounce_delay         = config.getfloat("debounce_delay",         0.)
 
         self.debug                  = config.getboolean('debug', False)             # Setting to True turns on more debugging to show on console
         self.testing                = config.getboolean('testing', False)           # Set to true for testing only so that failure states can be tested without stats being reset
@@ -248,8 +252,8 @@ def _update_trsync(self, config):
         if update_trsync:
             try:
                 import mcu
-                trsync_value = config.getfloat("trsync_timeout", 0.05)              # Timeout value to update in klipper mcu. Klippers default value is 0.025
-                trsync_single_value = config.getfloat("trsync_single_timeout", 0.5) # Single timeout value to update in klipper mcu. Klippers default value is 0.250
+                trsync_value = config.getfloat("trsync_timeout", 0.05)              # Timeout value to update in klipper mcu. Klipper's default value is 0.025
+                trsync_single_value = config.getfloat("trsync_single_timeout", 0.5) # Single timeout value to update in klipper mcu. Klipper's default value is 0.250
                 self.logger.info("Applying TRSYNC update")
 
                 # Making sure value exists as kalico(danger klipper) does not have TRSYNC_TIMEOUT value
@@ -309,10 +313,10 @@ def handle_connect(self):
         try:
             self.bypass = self.printer.lookup_object('filament_switch_sensor bypass').runout_helper
         except:
-            self.bypass = add_filament_switch("filament_switch_sensor virtual_bypass", "afc_virtual_bypass:virtual_bypass", self.printer ).runout_helper
+            self.bypass = add_filament_switch("virtual_bypass", "afc_virtual_bypass:virtual_bypass", self.printer ).runout_helper
 
         if self.show_quiet_mode:
-            self.quiet_switch = add_filament_switch("filament_switch_sensor quiet_mode", "afc_quiet_mode:afc_quiet_mode", self.printer ).runout_helper
+            self.quiet_switch = add_filament_switch("quiet_mode", "afc_quiet_mode:afc_quiet_mode", self.printer ).runout_helper
 
         # Register G-Code commands for macros we don't want to show up in mainsail/fluidd
         self.gcode.register_command('TOOL_UNLOAD',          self.cmd_TOOL_UNLOAD,           desc=self.cmd_TOOL_UNLOAD_help)
@@ -378,7 +382,7 @@ def _get_default_material_temps(self, cur_lane):
         in AFC.cfg and sees if a temperature exists for filament material.
 
         :param cur_lane: Current lane object
-        :return truple : float for temperature to heat extruder to,
+        :return tuple : float for temperature to heat extruder to,
                          bool True if user is using min_extruder_temp value
         """
         try:
@@ -1488,7 +1492,6 @@ def cmd_CHANGE_TOOL(self, gcmd):
         CHANGE_TOOL LANE=lane1 PURGE_LENGTH=100
         ```
         """
-        self.afcDeltaTime.set_start_time()
         # Check if the bypass filament sensor detects filament; if so, abort the tool change.
         if self._check_bypass(unload=False): return
 
@@ -1530,6 +1533,7 @@ def cmd_CHANGE_TOOL(self, gcmd):
         self.CHANGE_TOOL(self.lanes[self.tool_cmds[Tcmd]], purge_length)
 
     def CHANGE_TOOL(self, cur_lane, purge_length=None, restore_pos=True):
+        self.afcDeltaTime.set_start_time()
         # Check if the bypass filament sensor detects filament; if so, abort the tool change.
         if self._check_bypass(unload=False): return
 

extras/AFC_BoxTurtle.py

@@ -123,7 +123,7 @@ def calibrate_bowden(self, cur_lane, dis, tol):
                                                              cur_lane.short_move_dis, 0, cur_lane.dist_hub + 200, "Moving to hub")
 
         if not success:
-            # if movement does not suceed fault and return values to calibration macro
+            # if movement does not succeed fault and return values to calibration macro
             msg = 'Failed {} after {}mm'.format(checkpoint, hub_pos)
             return False, msg, hub_pos
 
@@ -170,26 +170,27 @@ def calibrate_bowden(self, cur_lane, dis, tol):
             else:
                 bowden_dist = bow_pos - cur_lane.short_move_dis
 
-            # Checking if user has set a custom unload length and adding the delta to the new
-            # calibrated bowden distance
-            if cur_lane.hub_obj.afc_unload_bowden_length != cur_lane.hub_obj.afc_bowden_length:
-                unload_delta = cur_lane.hub_obj.afc_unload_bowden_length - cur_lane.hub_obj.afc_bowden_length
-                unload_new = bowden_dist + unload_delta
-            else:
-                unload_new = bowden_dist
+            unload_dist = bowden_dist
 
             cal_msg = '\n afc_bowden_length: New: {} Old: {}'.format(bowden_dist, cur_lane.hub_obj.afc_bowden_length)
-            unload_cal_msg = '\n afc_unload_bowden_length: New: {} Old: {}'.format(unload_new, cur_lane.hub_obj.afc_unload_bowden_length)
+            unload_cal_msg = '\n afc_unload_bowden_length: New: {} Old: {}'.format(unload_dist, cur_lane.hub_obj.afc_unload_bowden_length)
             cur_lane.hub_obj.afc_bowden_length = bowden_dist
-            cur_lane.hub_obj.afc_unload_bowden_length = unload_new
+            cur_lane.hub_obj.afc_unload_bowden_length = unload_dist
 
             if bowden_dist < 0:
                 self.afc.error.AFC_error(
                     "'{}' is not a valid length. Please check your setup and re-run calibration.".format(bowden_dist),
                     pause=False)
                 return False, "Invalid bowden length", bowden_dist
+
+            if unload_dist < 0:
+                self.afc.error.AFC_error(
+                    "'{}' is not a valid unload length. Please check your setup and re-run calibration.".format(unload_dist),
+                    pause=False)
+                return False, "Invalid unload bowden length", unload_dist
+
             self.afc.function.ConfigRewrite(cur_hub.fullname, "afc_bowden_length", bowden_dist, cal_msg)
-            self.afc.function.ConfigRewrite(cur_hub.fullname, "afc_unload_bowden_length", unload_new, unload_cal_msg)
+            self.afc.function.ConfigRewrite(cur_hub.fullname, "afc_unload_bowden_length", unload_dist, unload_cal_msg)
             cur_lane.loaded_to_hub  = True
             cur_lane.do_enable(False)
             self.afc.save_vars()
@@ -228,7 +229,7 @@ def calibrate_hub(self, cur_lane, tol):
         return True, msg, tuned_hub_pos
 
     def move_until_state(self, cur_lane, state, move_dis, tolerance, short_move, pos=0, fault_dis=250, checkpoint=None):
-        # moves filament until specified sensor, returns values for further czlibration
+        # moves filament until specified sensor, returns values for further calibration
         while not state():
             cur_lane.move(move_dis, cur_lane.short_moves_speed, cur_lane.short_moves_accel)
             pos += move_dis

extras/AFC_HTLF.py

@@ -31,7 +31,7 @@ def __init__(self, config):
         self.current_selected_lane  = None
         self.home_state             = False
         self.mm_move_per_rotation   = config.getint("mm_move_per_rotation", 32)                                     # How many mm moves pulley a full rotation
-        self.cam_angle              = config.getint("cam_angle")                                                    # CAM lobe angle thats currently installed. 30,45,60 (recommend using 60)
+        self.cam_angle              = config.getint("cam_angle")                                                    # CAM lobe angle that is currently installed. 30,45,60 (recommend using 60)
         self.home_pin               = config.get("home_pin")                                                        # Pin for homing sensor
         self.MAX_ANGLE_MOVEMENT     = config.getint("MAX_ANGLE_MOVEMENT", 215)                                      # Max angle to move lobes, this is when lobe 1 is fully engaged with its lane
         self.enable_sensors_in_gui  = config.getboolean("enable_sensors_in_gui", self.afc.enable_sensors_in_gui)    # Set to True to show prep and load sensors switches as filament sensors in mainsail/fluidd gui, overrides value set in AFC.cfg
@@ -47,10 +47,8 @@ def __init__(self, config):
         buttons = self.printer.load_object(config, "buttons")
         buttons.register_buttons([self.home_pin], self.home_callback)
 
-        if self.enable_sensors_in_gui:
-            if self.home_pin is not None:
-                self.home_filament_switch_name = "filament_switch_sensor {}_home_pin".format(self.name)
-                self.home_sensor = add_filament_switch(self.home_filament_switch_name, self.home_pin, self.printer )
+        if self.home_pin is not None:
+            self.home_sensor = add_filament_switch(f"{self.name}_home_pin", self.home_pin, self.printer, self.enable_sensors_in_gui )
 
     def handle_connect(self):
         """
@@ -85,6 +83,7 @@ def system_Test(self, cur_lane, delay, assignTcmd, enable_movement):
         if not self.prep_homed:
             self.return_to_home( prep = True)
         status = super().system_Test( cur_lane, delay, assignTcmd, enable_movement)
+        self.return_to_home()
 
         return self.prep_homed and status
 
@@ -157,7 +156,7 @@ def select_lane( self, lane ):
         """
         self.failed_to_home = False
         if self.current_selected_lane != lane:
-            self.logger.debug("HTLF: {} Homing to endstop".format(self.name))
+            self.logger.debug("HTLF: {} Homing to endstop.".format(self.name))
             if self.return_to_home():
                 self.selector_stepper_obj.move(self.calculate_lobe_movement( lane.index ), 50, 50, False)
                 self.logger.debug("HTLF: {} selected".format(lane))

extras/AFC_assist.py

@@ -640,7 +640,7 @@ def assist(self, value):
 
     def break_espooler(self):
         """
-        Helper function to "brake" n20 motors to hopefully help with keeping down backfeeding into MCU board
+        Helper function to "brake" n20 motors to hopefully help with keeping down back-feeding into MCU board
         """
         print_time = self.afc.toolhead.get_last_move_time()
         if self.afc_motor_enb is not None:

extras/AFC_buffer.py

@@ -57,12 +57,11 @@ def __init__(self, config):
         self.multiplier_high    = config.getfloat("multiplier_high", default=1.1, minval=1.0)
         self.multiplier_low     = config.getfloat("multiplier_low", default=0.9, minval=0.0, maxval=1.0)
 
-        if self.enable_sensors_in_gui:
-            self.adv_filament_switch_name = "filament_switch_sensor {}_{}".format(self.name, "expanded")
-            self.fila_avd = add_filament_switch(self.adv_filament_switch_name, self.advance_pin, self.printer )
+        self.adv_filament_switch_name = "{}_{}".format(self.name, "expanded")
+        self.fila_avd = add_filament_switch(self.adv_filament_switch_name, self.advance_pin, self.printer, show_sensor=self.enable_sensors_in_gui )
 
-            self.trail_filament_switch_name = "filament_switch_sensor {}_{}".format(self.name, "compressed")
-            self.fila_trail = add_filament_switch(self.trail_filament_switch_name, self.trailing_pin, self.printer )
+        self.trail_filament_switch_name = "{}_{}".format(self.name, "compressed")
+        self.fila_trail = add_filament_switch(self.trail_filament_switch_name, self.trailing_pin, self.printer, show_sensor=self.enable_sensors_in_gui )
 
         self.printer.register_event_handler("klippy:ready", self._handle_ready)