This Klipper plugin is for use with modern filament control systems such as BoxTurtle, NightOwl etc.
More information about BoxTurtle can be found here
Further information to include command references can be found in the docs folder.
Usage instructions for the install-afc.sh script can be shown by running:
./install-afc.sh -hTo install this plugin, you should have the following pre-requisites installed:
- Klipper
- Moonraker
- WebUI (Mainsail or Fluidd)
To install this plugin, you can use the following commands from the users home directory:
cd ~
git clone https://github.com/ArmoredTurtle/AFC-Klipper-Add-On.git
cd AFC-Klipper-Add-On
./install-afc.shTo update the AFC plugin software, you can simply run the following command:
cd AFC-Klipper-Add-On
./install-afc.shThe update process should be non-destructive and will not overwrite any existing configuration files without your permission.
If you run into an issue due to a specific configuration, you may need to comment out the AFC plugin software and re-run the install-afc.sh script.
This can be accomplished by commenting out the following lines in your printer.cfg file:
[include AFC/*.cfg]Once the plugin is updated, please uncomment the lines in your printer.cfg file (if applicable).
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.
Additionally, review the following files for any changes that may be required:
~/printer_data/config/AFC/AFC.cfg~/printer_data/config/AFC/AFC_Macro_Vars.cfg~/printer_data/config/AFC/AFC_Turtle_1.cfg
Review information in mandatory configuration changes section
To manually install and configure the plugin, you can use the following commands:
cd ~
git clone https://github.com/ArmoredTurtle/AFC-Klipper-Add-On.git
cd AFC-Klipper-Add-On
ln -sf ~/AFC-Klipper-Add-On/extras/*.py ~/klipper/klippy/extras/
mkdir -p ~/printer_data/config/AFC
cp -R ~/AFC-Klipper-Add-On/config/* ~/printer_data/config/AFC/Next, please copy the appropriate AFC_Hardware.cfg template file from ~/AFC-Klipper-Add-On/templates to ~/printer_data/config/AFC
and modify the file to match your hardware configuration. Ensure you rename the file properly based on the selected board type to AFC_Hardware.cfg.
You should also copy the AFC_Turtle_1.cfg template file from ~/AFC-Klipper-Add-On/templates to ~/printer_data/config/AFC and modify this file to match your hardware configuration.
Finally, review and update the following files as needed for your configuration.
~/printer_data/config/AFC/AFC.cfg~/printer_data/config/AFC/AFC_Macro_Vars.cfg~/printer_data/config/AFC/AFC_Hardware.cfg~/printer_data/config/AFC/AFC_Turtle_1.cfg
To enable the AFC plugin in Moonraker, you should add the following lines to your moonraker.conf file:
[update_manager afc-software]
type: git_repo
path: ~/AFC-Klipper-Add-On
origin: https://github.com/ArmoredTurtle/AFC-Klipper-Add-On.git
managed_services: klipper
primary_branch: main
is_system_service: False
info_tags:
desc=AFC Klipper Add OnPrior to operation, the following checks / updates MUST be made to your system:
-
Update the following values in the
~/printer_data/config/AFC/AFC_Hardware-{board}.cfgfile:
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_unload: This value is the amount to unload from extruder when doing a filament change.
-
Update the following in the
~/printer_data/config/AFC/AFC_Turtle_{n}.cfgfile:
for systems with a single unit, the file will show asAFC_Turtle_1.cfgaddtional units with be 2, 3 etc.- afc_bowden_length: This value is the length from your hub to your toolhead sensor
-
Verify that
pin_tool_startis set to the correct pin for your toolhead sensor. If you are using an existing filament sensor as your toolhead sensor make sure you comment out any filament sensor sections in yourprinter.cfgfile. -
If you are using any of the built-in macros, the variables in the
~/printer_data/config/AFC/AFC_Macro_Vars.cfgfile must also be modified to match your configuration for your system.Required variables to verify and update if necessary for the following default macros - tool_cut: - variable_retract_length - variable_cut_direction - variable_pin_loc_xy - variable_pin_park_dist - variable_cut_move_dist - park: - variable_park_loc_xy - poop: - variable_purge_loc_xy - kick: - variable_kick_start_loc - variable_kick_direction - wipe - variable_brush_loc - variable_y_brush - form_tip Variables to update for tip forming are in `~/printer_data/config/AFC/AFC.cfg` - cooling_tube_position - cooling_tube_length -
If you would like to use your own macro instead of the provided macros, make sure to update the command with your custom macro in
~/printer_data/config/AFC/AFC.cfg
ex. If using custom park macro, changepark_cmdfromAFC_PARKto your macro name
Failure to update these values can result in damage to your system
If you use a Turtleneck v2, you can enable the buffer indicator LED by adding the following lines to your AFC.cfg file:
led_buffer_advancing: 0,0,1,0
led_buffer_trailing: 0,1,0,0
led_buffer_disable: 0,0,0,0.25If using a hub that is not located in the box turtle the following value needs to be updated for each stepper
- dist_hub: This value the the length between the lanes extruder and the hub, this does not have to be exact and is better to figure the length and then minus about 40mm
If using snappy hub cutter update the following values:
- cut: change to True
- cut_dist: update to the value that you would like to cut off the end, this may take some tuning to get right
If you are using a buffer such as the Turtleneck, Turtleneck v2 or Annex Belay, and you installed the software manually, you may need to make a couple of additional changes.
You should add the following block to your AFC_Turtle_1.cfg file based on the type of buffer you are using.
NOTE The pin value should be set to the pin that the buffer is connected to on your board.
If direct loading to an extruder is desired the following lines need to be added to the [AFC_stepper ] of choice.
hub: directWhen using this will cause the spool to automatically load to the extruder. There should be no Hub in-between that lane and the extruder. Using 'direct' will disable calabrations for that lane.
[AFC_buffer TN]
advance_pin: # set advance pin
trailing_pin: # set trailing pin
multiplier_high: 1.05 # default 1.05, factor to feed more filament
multiplier_low: 0.95 # default 0.95, factor to feed less filament
velocity: 100Turtleneck v2
[AFC_buffer TN2]
advance_pin: !turtleneck:ADVANCE
trailing_pin: !turtleneck:TRAILING
multiplier_high: 1.05 # default 1.05, factor to feed more filament
multiplier_low: 0.95 # default 0.95, factor to feed less filament
led_index: Buffer_Indicator:1
velocity: 100
[AFC_led Buffer_Indicator]
pin: turtleneck:RGB
chain_count: 1
color_order: GRBW
initial_RED: 0.0
initial_GREEN: 0.0
initial_BLUE: 0.0
initial_WHITE: 0.0Annex Belay
[AFC_buffer Belay]
pin: mcu:BUFFER
distance: 12
velocity: 1000
accel: 1000Finally, add buffer: <buffer_name> to either your AFC_extruder, AFC_stepper, or AFC_<unit_type> sections in AFC_Turtle_(n).cfg files. For example, if you are using the Turtleneck v2, you would add the following line:
Using this config, buffer will be used for every unit that uses this extruder
[AFC_extruder extruder]
buffer: TN2Using this config, buffer will be used for every lanes that uses this unit
[AFC_BoxTurtle Turtle_1]
buffer: TN2Using this config, buffer will be used for just the lanes the buffers is assigned to, this will override anything set in extruder/unit sections
[AFC_stepper lane1]
buffer: TN2Additional information about the buffer configuration and operation can be found in the AFC_buffer.md file.
Call AFC_CALIBRATION in your gui of choice and follow the prompts to calibrate your AFC system.
distances will be calibrated to have ~1 short move after the move distance
All values will be automatically updated in the proper config sections after calibration
If using a hub different from the stock set up hub_clear_move_dis under AFC unit may need to be increased/decreased to match your setup, default 50mm.
For additional information and the steps for manual calibration, can be found in Calibration.md
Debug information about the respooler system can be found by visiting the following URL in your browser:
{ip address}/printer/afc/status
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.
- color_order: change to match the color order for you leds. Different color orders are: RGB, RGBW, GRB, GRBW
During unloads if your filament retracts too much and goes past the lanes extruder then decrease your afc_bowden_length value in ~/printer_data/config/AFC/AFC.cfg file
If you keep getting TTC errors start by adding the following to AFC/AFC.cfg file under [AFC] section
trsync_update: True
If you notice a layer shift occurs while using the cut macro, setting a higher stepper current while cutting has shown to help with this.
Update and uncomment the following values in AFC/AFC_Macr_Vars.cfg file
- variable_cut_current_stepper_x - start with ~1.7-1.8A
- variable_cut_current_stepper_y - start with ~1.7-1.8A
- Only needed if cutting action is along the z - variable_cut_current_stepper_z
Make sure your stepper names are updated for variables: variable_cut_current_stepper_x, variable_cut_current_stepper_y, variable_cut_current_stepper_z
To remove the plugin, you can use the following commands:
cd ~/AFC-Klipper-Add-On
./install-afc.shOnce the installation program starts, please select the option to remove the plugin.
Armored Turtle Configuration / Build Manuals here
