Merge pull request #445 from ArmoredTurtle/DEV Release v1.0.20 DEV to main

Release v1.0.20 DEV to main

Author: jimmyjon711

.github/pull_request_template.md

@@ -10,3 +10,8 @@
 - [ ] CHANGELOG.md is updated (if end-user facing)
 - [ ] Documentation updated in AT-Documentation repository
 - [ ] Sent notification to software-design channel requesting review
+- [ ] If this PR address a GitHub issue, the issue number is referenced in the PR description
+
+**NOTE**: GitHub Copilot may be used for automated code reviews, however as it is an automated system, it's suggestions 
+may not be correct. Please do not rely on it to catch all issues. Please review any suggestions it makes and use your 
+own judgement to determine if they are correct.

CHANGELOG.md

@@ -5,6 +5,143 @@ 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-06-10]
+### Added
+- Ability to turn on print assist if spool falls below a certain weight
+- Weight defaults to 1kg when first inserting spool
+- `AFC_CLEAR_MESSAGE` macro to clear current message that would be displayed in gui's
+- When saving variables and key is not found in current AFC files, a new file `AFC_auto_vars.cfg` will be created and variables will be added to that file
+
+## [2025-06-08]
+### Added
+- Support for [QuattroBox](https://github.com/Batalhoti/QuattroBox) filament changer. QuattroBox can be chosen in install script for new or additional units to add to your printer
+
+## [2025-06-07]
+### Fixed
+- `unknown command: Prompt_end` error will no longer show when users try to exit out of Happy Printing popup after AFC_CALIBRATION is done
+- Lanes are now marked a loaded_to_hub when bowden calibration happens
+- Fixed issue where HTLF might error out when first homing during PREP
+
+## [2025-06-06]
+### Added
+- There is now a configurable option `error_timeout` in the `[AFC]` section of the `AFC.cfg` file. This option allows 
+users to set a timeout for how long the printer will stay in a paused state when an error occurs. The default value is 
+`36000` seconds (10 hours). When a `PAUSE` action is triggered, AFC will now compare the value of the `error_timeout` and
+the `idle_timeout` value (if defined) and choose the larger of the two values. 
+
+### Changed
+- The `afc-debug.sh` script will now create a zip file of the logs if the `nc` utility is not available. 
+
+
+## [2025-05-30]
+### Added
+- Updated park to allow moving to an absolute z height after the x,y move. This is intended to reduce oozing during unload and load prior to using the poop command.
+
+## [2025-05-29]
+### Fixed
+- HTLF infinite runout now works correctly
+
+## [2025-05-27]
+### Added
+- Some AFC macros are now exposed in Mainsail/Fluidd. 
+
+## [2025-05-25]
+### Fixed
+- Exclude object bug where klipper would error out with max extrude error after excluding an object and 
+  trying to do a lane swap or doing TOOL_UNLOAD in PRINT_END function. Fixes issue [#364](https://github.com/ArmoredTurtle/AFC-Klipper-Add-On/issues/364)
+- Fixing issue [#348](https://github.com/ArmoredTurtle/AFC-Klipper-Add-On/issues/348)
+
+## [2025-05-24]
+### Fixed
+- The calibration routines will now not allow a negative bowden length value to be set. If a negative value is detected, 
+an error message will be displayed and the value will not be set.
+
+## [2025-05-23]
+### Updated
+- The `PREP` sequence will now check to ensure the trailing and advance buffer switches are not both triggered. If 
+  both switches are triggered, a warning message will be displayed.
+
+## [2025-05-22]
+### Added
+- Added `auto_home` support,
+
+## [2025-05-22]
+### Added
+- Added statistics tracking for tool load/unload/total change, n20 runtime, number of cuts,
+  average load/unload/full toolchange times, and number of load per lane.
+- Added ability to track when last blade was changed and how many cuts since last changed
+- `AFC_STATS` macro added to print statistics out. Set `SHORT=1` to print out a skinny version
+- `AFC_CHANGE_BLADE` macro added for when users change blade as this reset count and updates date changed
+- `AFC_RESET_MOTOR_TIME` macro added to allow users to reset N20 active time if motor was replaced in a lane
+- Added common class for easily interacting with moonraker api
+- Updated to use moonrakers proxy when fetching spoolmans data
+- Added getting toolchange count from moonrakers file metadata, `SET_AFC_TOOLCHANGES` will be deprecated
+  Moonrakers version needs to be at least v0.9.3-64
+- Updated import error message to pull from a common error string in AFC_utils.py file
+- Clearing pause in klipper when starting a print
+- Warning message is outputted when number of cuts is within 1K of tool_cut_threshold value
+- Error message is outputted when number of cuts is over tool_cut_threshold
+
+### Fixed
+- Issue where virtual bypass was being set for newly installed instances of AFC
+
+## [2025-05-21]
+### Added
+- new macro `AFC_TOGGLE_MACRO` to enable disable other macros.
+
+## [2025-05-15]
+### Added
+- added quiet mode support. `quiet_moves_speed` on `AFC.cfg` dictates the max speed when quiet mode is enabled.
+- new macro `AFC_QUIET_MODE ENABLE=1/0 SPEED=<max_speed>` to allow modifying `quiet_moves_speed` and enable/disable quiet mode.
+
+## [2025-05-12]
+### Added
+- new variable `tool_homing_distance` in `[AFC]` to make the distance over which toolhead homing is attempted.
+- new variable `rev_long_moves_speed_factor` added to `AFC_lane` to allow per lane reverse speed for long moves. i.e. long move speeds will now be `rev_long_moves_speed_factor * long_move_speed`.
+- new macro `SET_LONG_MOVE_SPEED LANE=<lane_name> FWD_SPEED=<fwd_speed> RWD_FACTOR=<rwd_multiplier> SAVE=1/0` to allow modifying `rev_long_moves_speed_factor` and `long_move_speed`
+
+
+## [2025-05-11]
+### Changed
+- The `install-afc.sh` script will remove any `velocity` settings present in the `[AFC_buffer <buffer_name>]` 
+  section of the configuration files as they are no longer needed.
+
+## [2025-05-01]
+### Added
+- Print assist is now filament usage based and will activate spool after a specified amount of filament is used. This is enabled by default.
+
+### Removed
+- Removed velocity from AFC_buffer code and install code, please remove `velocity`  variable from AFC_buffer configuration
+
+## [2025-04-27]
+
+### Removed
+- Removed deprecated belay code.
+
+## [2025-04-25]
+### Added
+- The AFC_CUT macro now supports a servo-activated pin. Set values for ``[servo tool_cut]`` in ``AFC_Hardware.cfg`` and enable ``tool_servo_enable`` in ``AFC_Macro_Vars.cfg``
+
+## [2025-04-23]
+
+### Added
+- The `install-afc.sh` script will now prompt you if you want to update the AFC provided macros when updating the 
+  software. **WARNING** This will overwrite any existing macros present. 
+
+## [2025-04-20]
+
+### Changed
+- Updated poop to do z lift based off last position so that toolhead does not smash into large poops.
+- Updated kick to move xy first and then move z so toolhead does not smash into poop.
+
+## [2025-04-19]
+
+### Changed
+- The `Type` parameter in the `AFC_<unit_type>.cfg` file is no longer required.
+
+- The `install-afc.sh` script will now check for updates, and if new updates are present, it will sync and git changes
+and re-run the script automatically.
+
 ## [2025-04-12]
 
 ### Added

CONTRIBUTING.md

@@ -1,5 +1,50 @@
-# Contributing
 
+# Contributing to This Project
+
+Thanks for your interest in contributing! Whether it's a bug report, new feature, or documentation fix, your help is welcome and appreciated.
+
+## Getting Started
+
+1. **Fork the repository** and create your branch from `main` or the default branch.
+2. Make your changes, following the guidelines below.
+3. Submit a [pull request](https://github.com/ArmoredTurtle/AFC-Klipper-Add-On/pulls).
+
+**NOTE** All pull requests should be up to date with the latest changes from the `DEV` branch and PRs should be opened against the `DEV` branch.
+
+## Guidelines
+
+### Code Style
+
+- Python code should follow [PEP 8](https://peps.python.org/pep-0008/) as closely as possible.
+- Use meaningful commit messages.
+- Keep changes focused—avoid mixing unrelated fixes or features.
+
+### Scripts
+
+- Bash scripts should be POSIX-compliant where practical.
+- Include a `#!/bin/bash` or `#!/usr/bin/env bash` shebang as appropriate.
+- Add inline comments to explain non-obvious logic.
+
+### Testing
+
+- If applicable, test your changes with your Klipper environment.
+- Make sure your code doesn't introduce errors or break existing functionality.
+- While formal unit tests may not be in place yet, please validate your changes manually.
+
+### Pull Requests
+
+- Clearly describe what your PR does and why it’s useful.
+- Link to any relevant issues.
+- Smaller PRs are easier to review and merge—break large changes into smaller steps if you can.
+
+## Bug Reports & Feature Requests
+
+- Use GitHub [Issues](https://github.com/ArmoredTurtle/AFC-Klipper-Add-On/issues) to report bugs or request features.
+- When reporting a bug, please include:
+  - A description of the issue
+  - Steps to reproduce
+  - Any relevant logs or configuration
+  
 ## Virtual environment
 
 It is recommended to set up a python virtual environment to keep installed dependencies isolated from your system dependencies.
@@ -42,7 +87,7 @@ should configure that for VSCode, but you may need to refer to your own IDE for
 ## Linting
 
 ```shell
-ruff check
+ruff check .
 ```
 
 > [!TIP]

config/AFC.cfg

@@ -14,9 +14,10 @@ short_move_dis: 10              # Move distance for failsafe moves. Default is 1
                                 # 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: default: 235, PLA:210, ABS:235, ASA:235 # Default temperature to set extruder when loading/unloading lanes.
+default_material_temps: default: 235, PLA:210, PETG:235, 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
+common_density_values: PLA:1.24, PETG:1.23, ABS:1.04, ASA:1.07 # Generic default density values.  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
@@ -25,6 +26,7 @@ load_to_hub: True               # Fast loads filament to hub when inserted, set
 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)
+#print_short_stats: True          # Set to true to print AFC_STATS in short form instead of wide form, printing short form is better for consoles that are small in width
 #debug: True                     # Setting to True turns on more debugging to show on console
 
 #--=================================================================================-
@@ -40,6 +42,7 @@ assisted_unload: True           # If True, the unload retract is assisted to pre
 z_hop: 5                        # Height to move up before and after a tool change completes
 resume_speed: 120               # Speed mm/s of resume move. Set to 0 to use gcode speed
 resume_z_speed: 30              # Speed mm/s of resume move in Z. Set to 0 to use gcode speed
+error_timeout: 36000            # Time in seconds to pause when an error is detected.
 
 
 #--=================================================================================-
@@ -54,6 +57,7 @@ led_tool_loaded: 0,0,1,0        # Loaded color            (R,G,B,W) 0 = off, 1 =
 led_buffer_advancing: 0,0,1,0   # Buffer advancing color  (R,G,B,W) 0 = off, 1 = full brightness.
 led_buffer_trailing: 0,1,0,0    # Buffer trailing color   (R,G,B,W) 0 = off, 1 = full brightness.
 led_buffer_disable: 0,0,0,0.25  # Buffer disable color    (R,G,B,W) 0 = off, 1 = full brightness.
+led_spool_illuminate: 1,1,1,0   # Loading color           (R,G,B,W) 0 = off, 1 = full brightness.
 
 #--=================================================================================-
 #------- Macro Config ---------------------------------------------------------------
@@ -69,6 +73,7 @@ led_buffer_disable: 0,0,0,0.25  # Buffer disable color    (R,G,B,W) 0 = off, 1 =
 
 # TOOL Cutting Settings
 tool_cut: True                  # Enable Cut macro.
+tool_cut_threshold: 10000       # Threshold value for message to change blade, warning starts at 1000k cuts before hitting this number
 tool_cut_cmd: AFC_CUT           # Cut macro name.
 
 # Park Settings

config/AFC_Macro_Vars.cfg

@@ -111,6 +111,11 @@ variable_safe_margin_xy           : 30, 30    # Approx toolhead width +5mm, heig
 # variable_conf_name_stepper_z: "tmc2209 stepper_z"
 # variable_awd: True
 
+# Addon variables for cutter pin servo control
+#variable_tool_servo_enable        : False
+#variable_tool_servo_name          : "tool_cut"
+#variable_tool_servo_angle_out     : 115
+#variable_tool_servo_angle_in      : 0
 
 #--=================================================================================-
 #------- Poop ----------------------------------------------------------------------
@@ -127,13 +132,15 @@ variable_z_purge_move             : True      # Set to False to not move in Z du
 # Speed, in mm/s to lift z after the purge is completed. Its a faster lift to keep it from 
 # sticking to the toolhead
 variable_fast_z                   : 200
-variable_z_lift                   : 20        # Z height to raise to after the purge is completed as part of the fast z move
+variable_z_lift                   : 10        # Z height to raise above the final purge position after the purge is completed as part of the fast z move
+                                              # example: If final poop height ends at 20mm this variable will raise Z to 30mm
 
 # If the toolhead returns to initial position after the poop is complete.
 variable_restore_position         : False     # True = return to initial position, False = don't return
 
-# The height to raise the nozzle above the tray before purging. This allows any built up 
+# The z height of the nozzle at the purge position before purging. This allows any built up
 # pressure to escape before the purge.
+
 variable_purge_start              : 0.6
 
 # Set the part cooling fan speed. Disabling can help prevent the nozzle from cooling down 
@@ -171,7 +178,7 @@ variable_purge_length_minimum     : 60.999
 description: Kick macro configuration variables
 gcode: # Leave empty
 
-variable_kick_start_loc           : -1,-1,10  # Location to move before kick
+variable_kick_start_loc           : -1,-1,5  # Location to move before kick
 variable_kick_z                   : 1.5       # Height to drop to for kick move
 variable_kick_speed               : 150       # Speed of kick movement
 variable_kick_accel               : 0         # Accel of kick moves. This will overwrite the global accel for this macro. Set to 0 to use global accel
@@ -210,4 +217,7 @@ gcode: # Leave empty
 
 variable_park_loc_xy              : -1, -1    # Position to park the toolhead
 # If you want z_hop during toolchanges please set the value in the AFC.cfg
-variable_z_hop                    : 0         # Height to raise Z when moving to park. Leave 0 to disable
+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.

config/macros/Brush.cfg

@@ -2,19 +2,19 @@
 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 accel             = gVars['accel']           | default(2000)  | float %}
+    {% set travel_speed      = gVars['travel_speed']    | default(120)*60| float %}
+    {% set z_travel_speed    = gVars['z_travel_speed']  | default(30)*60 | float %}
+    {% set verbose           = gVars['verbose']         | default(1)     | 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 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 z_move            = vars['z_move']     |float %}
+    {% set Bx, By, Bz        = vars.brush_loc           | default([-1,-1,-1])| map('float') %}
+    {% set brush_clean_accel = vars['brush_clean_accel']| default(0)         | float %}
+    {% set y_brush           = vars['y_brush']          | default(false)     | lower == 'true' %}
+    {% set brush_clean_speed = vars['brush_clean_speed']| default(150)*60    | float %}
+    {% set brush_width       = vars['brush_width']      | default(30)        | float %}
+    {% 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 %}
 
     # Get printer bounds to make sure none of our cleaning moves fall outside of them
     # Check for IDEX