Klicky¶
This page covers installing SimpleAF using a Klicky probe. New here? See Getting Started.
RPi / SBC users: install SimpleAF via SimpleAF for RPi. The rest of this page — mount options and calibration — applies to your setup too.
Firmware requirements¶
Limits on X and Y microsteps¶
You cannot use more than microsteps: 64 for [stepper_x] and [stepper_y], the MCU cannot handle high microsteps, it puts too much pressure on the mainboard and it will cause stuttering and other reliability issues including random crashes.
Note
This limit generally does not apply to RPi Series Simple AF
K1 Series¶
This guide assumes you have a K1, K1C, K1SE or K1 Max and you are running stock creality firmware 1.3.3.5 or higher (The firmware 1.3.3.5 is much older than 1.3.3.46 for example), or alternately you can use my prerooted firmware.
Ender 5 Max¶
This probe is currently not supported on Ender 5 Max
Ender 3 V3 KE¶
This probe is currently not supported on Ender 3 V3 KE
RPi or SBC¶
Probe Installation¶
All probe mount options assume you have purchased a PCB Klicky:
Mount Options¶
Default¶
Warning
This klicky dock is for the stock gantry only, it is highly unlikely to work with any other gantry, the dock would need to be remixed for that!
The models can be downloaded from https://www.printables.com/model/1170906-klicky-pcb-probe-for-creality-k1, but the instructions for wiring and the macros are not relevant and the wiring shown is a bit misleading, so just the models from printables nothing else. Don't forget the 1mm spacer on the toolhead otherwise the klicky does not properly line up when attached.
This mount should work for K1/K1C/K1SE and K1M, but only K1 and K1M variants have actually been tested.
Installation¶
Warning
The installation section does not apply to Simple AF for RPi, See Simple AF for RPi
The installation can only be performed on a printer which has been rooted and ssh granted
You need root access, if you are not already root, then follow the excellent Helper Script Enable Root Access instructions.
Factory Reset¶
If you've installed Guilouz's Helper Script, or installed Fluidd or Mainsail through any other means (such as from Creality directly), you need to factory reset before continuing.
Clone the Repo¶
git config --global http.sslVerify false
git clone https://github.com/pellcorp/creality.git /usr/data/pellcorp
Note
If you had already cloned the pellcorp creality repository before being asked to factory reset, the git repo is still there and you can skip the cloning step!
Run the installer¶
Note
If you have pellcorp-overrides in github but not stored locally, you need to recreate the ~/pellcorp-overrides directory before running the installer.sh!
To run the script, you must specify the probe you want to use.
Warning
Replace Mount with the specific mount option for the mount you have used, if you do not do this the printer will be incorrectly configured for your mount and dock location, and bed meshes, x and y limits and related config will be wrong. Please refer to Mount Options for supported mounts.
If you are using a non-supported mount you should specify a mount option as close to your mount as possible and properly adjust your configuration after installation before trying to perform a bed mesh or Screws Tilt Calculate!
Post Installation¶
MCU Firmware updates are pending¶
At the end of the installer process if you get this message:
It means that new MCU firmware updates need to be applied and this can only be done by power cycling the printer. After your printer is power cycled you can verify firmware was updated with the CHECK_FIRMWARE macro from Fluidd or Mainsail, if you see this message:
Your printer MCU firmware was updated successfully. If you still see the MCU Firmware updates are pending you need to power cycle your printer! message after a power cycle, check the /tmp/mcu_update.log, you may be asked to provide this file on Discord if you need additional assistance, sometimes an additional power cycle can solve the problem, there is a very short window of time (15 seconds) in which the MCU firmware can be updated, so there is a chance it will work after an additional power cycle.
Docking¶
Getting docking working if you are not using the Default mount or you have positioned the dock somewhere other than the rear left stepper motor is left as an exercise for
each user. Out of the box automatic docking is disabled for a new installation of Simple AF, you should verify the dock coordinates in the klicky_macro.cfg are correct, and you can then
flip the variable_auto_docking to True, save and restart and klicky will auto attach and dock for homing, bed meshing and start print.
Verifying Probe¶
It's really important to verify that the klicky actually will work as an endstop for homing, so initiate homing and then use your finger to activate the microswitch on the bottom of the klicky and make sure homing stops, if it does not stop you need to immediately use the e-stop button in your UI or Grumpyscreen or hit that power button
Slicer Settings¶
Calibration¶
Warning
The following calibration steps are required to setup a new printer:
Probe Calibrate¶
- Home All (
G28) - Make sure nozzle is centred on bed
- Run
PROBE_CALIBRATE - Manually remove klicky probe and put it into the dock
- Follow the Paper Test Method
Upon completionSAVE_CONFIG
Pid Tuning and Input Shaping¶
At least PID tuning (bed and extruder) and input shaping is required for acceptable printing. If you try and print after running the installer.sh and a power cycle but before any calibration you will most likely have horrendous quality, the worst you have ever seen on the k1. After PID tuning and input shaping you should see the same kind of quality as you get with stock k1 + input shaper fix.
Note
You can use the QUICK_START Macro to complete Bed and Nozzle PID Tuning and Input Shaping Automatically.
Pid Tuning¶
Source: Calibrate Pid Settings
For example you might run these:
Note
The PID_CALIBRATE_BED and PID_CALIBRATE_HOTEND macros are located in the useful_macros.cfg file and they have defaults values for BED_TEMP and HOTEND_TEMP so you can just run them by clicking on them if you want that same temperature.
Input Shaping¶
There is no default configuration for input shaping so it is essentially disabled out of the box.
You can use the SHAPER_CALIBRATE macro to run input shaping, just be sure to SAVE CONFIG at the end, to choose the automatically selected shaper config, be aware though that the shaper chosen might be sub-optimal due to a slight difference in vibrations between two options. So you should probably review the output and potentially choose an alternative if it gives you higher recommended max acceleration for minimal increase in vibration.
Axis Twist Compensation¶
It is highly recommended to perform axis twist compensation, this will affect the quality of your bed mesh, so best to do it before.
Tip
There is no need to run axis twist compensation if you have mounted the eddy with a side mount that has a 0 y offset!
- Home All (
G28) - Run
AXIS_TWIST_COMPENSATION_CALIBRATEThe calibration wizard will prompt you to measure the probe Z offset at a few points along the bed
Upon completionSAVE_CONFIG
Source: https://www.klipper3d.org/Axis_Twist_Compensation.html
First Print¶
You should optimise your probe z offset using baby stepping.
In fluidd the save button after you finish or cancel your print can be a bit hard to find, look for
Other Calibrations¶
Info
The default value for pressure advance is set to 0.04
Refer to Orcaslicer Calibration for more calibrations
Refer to the Ellis Print Tuning Guide for more great tuning ideas.
Where can I get help?¶
Danger
Getting the klicky setup correctly takes time and patience to ensure you do not damage your printer or the klicky, also when doing operations like homing and bed meshes and the like you should never leave your printer unattended in case docking or attaching fails for some reason.
For support, join the SimpleAF Discord.