Upgrades & updates
- Cartographer installation with Qidi stock firmware
- Updating and Flashing the the Toolhead MCU
- Beacon Rev H Probe Installation
- Shaketune Klippain Belt Magic
- Make WiFi work on vanilla Klipper Qidi machines with Tenda dongle and RTL8188GU chip
- Cartographer probe installation on vanilla Klipper
Cartographer installation with Qidi stock firmware
Cartographer is Eddy current bed probe, which makes bed meshing a lot faster and a lot more percise. There are several such probes out there. Most known is Beacon, which is made by US fellas, Cartographer, which is made by UK fellas and quite some of them in AliExpress
They are known for their speed and accuracy. If regular probe accuracy is around 0.001mm, then Eddy current probes are 0.0001mm, which is 10x more accurate. Their probing speed is limited by printer head moving speed and printer motherboard CPU. In theory they can do some milion measurements per second
Here's a 10 sec 15x15 grid full bed mesh, which takes with regular Probe around 45 minutes
Installation
This guide works with both V2 and V3 probes
Hardware and mounting
For installation can use this mount (for X-Max 3), For X-Plus 3, there's remix, original Beacon mount also works, but it's slightly flimsier. Make sure to print mount out of something that can sit near bed and wouldn't deform. PAHT-CF is good candidate, ABS and ASA work too, their GF and CF parts even better. PLA and PETG won't survive the bed heat from bed when using higher temperatures
Needed hardware:
4x M3x14 bolts original stock probe mount bolts. Stock probe has 2 bolts, there should be 2 extra that came with printer / official upgrade package as spare parts
2x M3 nuts to secure probe in place. Those didn't come with printer, had to buy
2x M2.5x16 had those with one of Qidi printers as spare parts too, can't remember if it was iFast or X-Max 3
Optional zipties to secure cable
Do not put cable into cable chain, USB cable is not rated for it, it's good to have it rather loose, so there's no single point that keeps on bending (Some users have reported in Discord, that cable broke after around 1k print hours in cable chain)
Good installation would be like this, just 3 rather loose zip-ties to secure the cable
After mounting it, move toolhand manually thro all 4 corners and check that cable doesn't get stuck behind anything
Software installation
For Cartographer software installation you can refer to it's own doc, but since there are some changes needed, wrote it down in here also. Follow Carto doc when you know what you are doing. Installing on stock Qidi firmware refer to this doc
First of all, need to SSH into printer. You can find printer IP from printer screen under network tab or from router.
SSH user is `mks` to printer with `mks@IP_ADDR` for example `mks@192.168.88.36`
Password is `makerbase`
By default Qidi printers have wrong system time, first need to update that by running apt install ntp and dpkg-reconfigure tzdata. Qidi Official wiki has good guide on it: https://wiki.qidi3d.com/en/Memo/System-Time-Modification
After updating datetime, going to install Cartographer software. Writing this guide in two parts, Bed meshing and Auto Z offset, since bed meshing is rather simple, auto z offset requires some more work with older Qidi firmwares
Bed meshing
Easy way will require minimal changes, but will be limited to having only bed mesh. For auto Z offset need to follow advanced part
cd-- Make sure you are at home directorygit clone https://github.com/Cartographer3D/cartographer-klipper.git-- Get Carto softwarecd cartographer-klipper-- Go to Cartographer foldergit checkout v1.0.0-- This will make you run older version of Carto software, that works with Qidi printers out of boxchmod +x ./install.sh-- Make Carto installation script executable./install.sh-- Execute install script- Running installation might give warning about Python version. It's safe to ignore it, since we pinned Cartographer software version to v1.0.0
After cartographer is installed, need to make some modifications to printer config. It's easiest to make it thro printer web UI (Fluidd). It's accessible at printer IP and port 10088, like http://192.168.88.36:10088/#/configure (replace IP with your printer IP).
For more advanced users, I'd recommend to connect VSCode to printer and edit ~/klipper_config/printer.cfg directly
Inside [stepper_z] need to change homing_retract_dist
- homing_retract_dist: 8.0
+ homing_retract_dist: 0 # cartographer needs this to be set to 0, was 8.0Inside [homing_override] need to get rid of references to printer.probe. printer.probe["x_offset"] is going to be removed and printer.probe["y_offset"] is going to be replaced with 25 (needs to be hardcoded, Qidi older Klipper doesn't work too well with variables, or McSneaky has no idea how to use them)
- G1 X{printer.toolhead.axis_maximum.x/2 - printer.probe["x_offset"]} Y{printer.toolhead.axis_maximum.y/2 - printer.probe["y_offset"]} F7800
+ G1 X{printer.toolhead.axis_maximum.x/2} Y{printer.toolhead.axis_maximum.y/2 - 25} F7800Inside [bed_mesh] section need to adjust mesh_min. It's also advised to change probe_count and speed. Those two can be whatever you feel comfortable with. Sweet spot seems to be speed somewhere between 150 to 600 and probe_count somewhere around 15 (odd numbers in probe_count are good, this way bed center point is also probed)
[bed_mesh]
-speed:150
+speed:300 #调平速度 CARTO CHANGED, used to be 150
horizontal_move_z:10 #调平中Z抬高高度
-mesh_min:25,10 #探测点最小位置
+mesh_min:25,20 #探测点最小位置 # CARTO CHANGED, used to be 25,10
mesh_max:315,315 #探测点最大位置
-probe_count:9,9 #调平点数
+probe_count:15,15 #调平点数 # CARTO CHANGED, used to be 9,9
algorithm:bicubic
bicubic_tension:0.2
mesh_pps: 4, 4Replace probe or bltouch section with cartographer. Inside cartographer default settings need to change y_offset to 25 and serial to your USB serial
To get USB serial run ls /dev/serial/by-id/ this will give you toolhead ID (usb-Klipper-rp2040-something) and Cartographer ID (usb-Cartographer-something). Copy / write down Cartographer ID
In the end your cartographer config should look something like this:
Be sure to update "serial" and "y_offset"
[cartographer]
# PASTE IN YOUR ID TO HERE!
serial: /dev/serial/by-id/usb-Cartographer_614e_1C0028001343565537353020-if00
# Path to the serial port for the Cartographer device. Typically has the form
#
# If you are using the CAN Bus version, replace serial: with canbus_uuid: and add the UUID.
# Example: canbus_uuid: 1283as878a9sd
#
speed: 40.
# Z probing dive speed.
lift_speed: 5.
# Z probing lift speed.
backlash_comp: 0.5
# Backlash compensation distance for removing Z backlash before measuring
# the sensor response.
x_offset: 0.
# X offset of cartographer from the nozzle.
y_offset: 25 ## BE SURE TO SET TO 25
# Y offset of cartographer from the nozzle.
trigger_distance: 2.
# cartographer trigger distance for homing.
trigger_dive_threshold: 1.5
# Threshold for range vs dive mode probing. Beyond `trigger_distance +
# trigger_dive_threshold` a dive will be used.
trigger_hysteresis: 0.006
# Hysteresis on trigger threshold for untriggering, as a percentage of the
# trigger threshold.
cal_nozzle_z: 0.1
# Expected nozzle offset after completing manual Z offset calibration.
cal_floor: 0.1
# Minimum z bound on sensor response measurement.
cal_ceil:5.
# Maximum z bound on sensor response measurement.
cal_speed: 1.0
# Speed while measuring response curve.
cal_move_speed: 10.
# Speed while moving to position for response curve measurement.
default_model_name: default
# Name of default cartographer model to load.
mesh_main_direction: x
# Primary travel direction during mesh measurement.
#mesh_overscan: -1
# Distance to use for direction changes at mesh line ends. Omit this setting
# and a default will be calculated from line spacing and available travel.
mesh_cluster_size: 1
# Radius of mesh grid point clusters.
mesh_runs: 2
# Number of passes to make during mesh scan.
# [safe_z_home]
# home_xy_position: 162.5, 162.5 # CARTO CHANGED
# # Example home_xy_position: 175,175 - This would be for a 350 * 350mm bed.
# z_hop: 3
[gcode_macro PROBE_CALIBRATE]
gcode:
CARTOGRAPHER_CALIBRATE
Notice, that in the end there's also macro for PROBE_CALIBRATE, don't forget to paste that in
Finally there's also some references to printer.probe in [gcode_macro M4029] need to replace them too
- G1 X{printer.toolhead.axis_maximum.x/2 - printer.probe["x_offset"]} Y{printer.toolhead.axis_maximum.y/2 - printer.probe["y_offset"]} F7800
+ G1 X{printer.toolhead.axis_maximum.x/2} Y{printer.toolhead.axis_maximum.y/2 - 25} F7800Now Cartographer is installed and configured. Next step is to do initial calibration
Don't forget to hit "Save and restart" in web UI!
Auto Z offset
This is to get auto Z offset working
Will write that soon :)
Initial calibration
There's no Qidi specifics in here. There are just two protips:
- If bed doesn't want to move up anymore and you get error: "out of bounds". Turn off printer and manually turn bed leadscrews to get bed close to nozzle. About ~5-10mm
- Hold your hand on power off switch during calibration and when doing initial test print. In case you did something wrong bed might collide to nozzle. It's good to turn off printer real fast then to not cause damage to PEI sheet
Other than that two, follow Cartographer docs: https://docs.cartographer3d.com/cartographer-probe/installation-and-setup/cartographer-with-input-shaper-v2-and-v3-hybrid
Updating and Flashing the the Toolhead MCU
By Einlander
The Qidi 3 series toolhead is based on the Makerbase THR36 and THR42 toolheads (https://github.com/makerbase-mks/MKS-THR36-THR42-UTC). Flashing the qidi toolhead is a similar experience. They both use a Raspberry Pi 2040 MCU and can/are controlled by USB. The major difference is the Qidi toolhead runs 24v over the USB lines. The Qidi printers run a version of Armbian Linux running Debian Buster.
The Process.
Here, we will break down the main steps to update and flash toolhead:
-
Compile the Klipper firmware.
-
Set the toolhead to DFU mode
-
Upload the firmware
Assumptions and Prerequisites
Wherever possible, we will proceed using the easiest method. Tough updating and flashing the toolhead can be done completely in Linux, we will assume that a Windows PC will be used. Software that will be used is any SSH client (I think Windows 10 has one built-in). I will assume that you know how to acquire, setup and use ssh.
MAKE SURE TO REMOVE ALL USB DRIVES AND MEMORY CARDS!
They may conflict or make this guide difficult to follow or complete.
Compiling Klipper firmware:
Connect to printer
First we need to log into the printer using ssh as the user mks. You connect by directly connecting to your printer by using it's IP address.
The address format is :
mks@your.ip.address.hereThe default password is
makerbase
Set the time
Before we do anything else, we need to set the time.
Failing to do this step may cause the update process to fail or become more difficult.
The command to set the date is
sudo date -s 'YYYY-MM-DD HH:MM:SS'the password is: makerbase
You can also try this command to try to set it automatically.
sudo date -s "$(wget -qSO- --max-redirect=0 google.com 2>&1 | grep Date: | cut -d' ' -f5-8)Z"
Kiauh
Now, we are at one of the main parts of updating and flashing the toolhead. For this, we will use KIAUH the Klipper Installer and Update Helper. In our case, it is already installed on the printer. To run it, we must first type this command:
~/kiauh/kiauh.shThis command will only work when logged in as mks. It will warn you if you use it as root.
KIAUH will ask you if you want to update, type:
Y
After it updates, we need to delete some folders.
This assumes you have never gone through this tutorial before. Qidi has customized some of the files, and KIAUH will fail when it finds them. You shouldn't need to do this in future updates. For our purposes, we will delete the directories.
sudo rm -r ~/klipper/
sudo rm -r ~/moonraker/Start KIAUH again by typing:
~/kiauh/kiauh.shYou should have arrived at the Main Menu screen:
First, we type 3 to get the Remove Menu.
Then we remove 1 Klipper , 2 Moonraker, and 3 Fluidd.
When it returns to the Remove Menu, we will Type B to return to the main menu.
Type 1 for the installation menu
Type 1 to install Klipper.
Type 1 to use Python 3.x
Type 1 to run one instance of Klipper
Wait for it to install.
When KIAUH returns to the Installation menu, Type 2 to install Moonraker and wait for the install. Then install 4 Fluidd, answering yes to the questions it asks.
Type B to return to the main menu and 2 to go to the Upgrade Menu.
Type 4 to upgrade Fluidd, then return to the main menu.
Type 4 to go to the Advanced Menu.
MCU Settings
The next screen you will see is the Klipper Firmware Configuration screen. Here, we will need to change the settings to match our toolhead mcu. Press space or enter to select items.
Select: Enable extra low-level configuration options
Select: Micro-controller Architecture (Raspberry Pi RP2040)
Then, leave everything else alone.
Press Q, then Y to save. The firmware will be built, and it will return us to the Advanced Menu.
Now, we want to quit KIAHU. Press B to return to the Main Menu and Q to quit.
Setting the toolhead to DFU mode
Setting the toolhead to DFU mode requires you to remove the back cover of the toolhead.
On the bottom left, there are two buttons labeled BOOT and RESET.
The easiest way to put it into DFU mode is to press and hold the BOOT button, press and release the RESET button, and then release the BOOT button.
You have to press the reset button while still holding the boot button.
To check if your toolhead is in DFU mode, type:
lsusb
lsblkIf you see an OpenMoko, Inc. device, it is not in DFU mode.
If you do not see an OpenMoko, Inc. device AND a sda disk with a MOUNTPOINT of /home/mks/gcode_files/sda1 the toolhead is in DFU mode.
The disk name may also be named sda, sdb, sdc, etc.
Uploading the Firmware
Now that the toolhead is in DFU mode, it will show up as a USB drive to the printer. Luckily QIDI decided to auto-mount USB drives for us.
To upload the firmware, we simply need to copy the compiled Klipper firmware file to the toolhead.
To do that type:
cp ~/klipper/out/klipper.uf2 ~/gcode_files/sda1/As soon as the file is copied, the toolhead will no longer be in DFU mode and it will disconnect the drive.
Finishing Up
Completing Moonraker Update
Turn the printer off and on. Then, connect to the web interface. In the console, you may see Moonraker prompting you to go to a specific IP address to complete the update.
Type your mks user password and close the window.
Restoring Settings
The new version of Klipper and Moonraker keep their save settings in a different location. We will copy them there.
cp -r ~/klipper_config/* ~/printer_data/configConnecting Klippy
The location of the klippy_uds_address has changed. If it tells you "klippy not connected" this may help repair it. From the web interface, edit moonraker.conf to change it to this:
klippy_uds_address: ~/printer_data/comms/klippy.sockRestoring Qidi Gcode functionality
QIDI added a feature that automatically mounted USB drives which is nice. But in their infinite wisdom, they decided to hard-code the location in their client. So, updating Klipper and Moonraker breaks it. There are 2 methods to fix it.
Patch it:
sed -i 's/printer_data/gcodes/gcode_files/g' ~/printer_data/systemd/moonraker.envThis method will keep the functionality and directories as it was, but may break in a future update.
Create a Symlink:
To fix it, a folder needs to be deleted and the old folder symlinked into its place, and the config changed. This method should last longer.
rm -r /home/mks/printer_data/gcodes/ln -s /home/mks/gcode_files /home/mks/printer_data/gcodessed -i 's:~/gcode_files:~/printer_data/gcodes:g' ~/printer_data/config/printer.cfgUpdating the printer.cfg
Some commands in printer.cfg have been changed. To update them, run:
sed -i 's:printer.probe\["x_offset"\]:printer.configfile.settings.probe.x_offset:g' ~/printer_data/config/printer.cfgsed -i 's:printer.probe["y_offset"]:printer.configfile.settings.probe.y_offset:g' ~/printer_data/config/printer.cfgPrecautions and incompatibilities
The versions of Klipper, Moonraker, and Fluidd installed will be updated. Avoid using the Qidi updates, it will overwrite the updated installation and the versions may be incompatible.
There is an issue with saving the z offset if you run the official/mainline version of Klipper. The software Qidi runs on the machine saves it's own copy of the zoffset. It interferes with klipper by adding it's copy of the zoffset to klippers zoffset resulting in either printing in the air, or grinding into your print bed.
Beacon Rev H Probe Installation
In case you need the mount for Rev H check this one out.
https://www.printables.com/model/727356-qidi-x-3-series-beacon-rev-h-probe-mount-further-i
Shaketune Klippain Belt Magic
You want to use the fantastic Shaketune Repo for your Qidi?
Note: latest version of Klippain requires an updated version of Klipper. Therefore it is not possible to achieve the installation of Klippain following the guide below.
Older version of Klippain 2.5.0 is also not working because of missing dependency on matplotlib==3.8.2 that cannot be installed on latest Qidi firmware (Jan 2024).
You can try to use the old version of Klippain 1.2.0
With those limitations in mind, continue on:
No Prob. Go here and install everything:
https://github.com/Frix-x/klippain-shaketune/blob/main/install.sh
Preparation
Qidi uses old v10 Klipper in the stock configuration. This means you have problems and manually need to change pathways.
Before you do anything set the system time correct via SSH!
SSH:
ssh mks@IP
password: makerbase
NTP install and useful alternatives to check out:
apt install ntp
and then
dpkg-reconfigure tzdata to select timezone
sudo date -s '2023-12-02 10:22:00'
sudo ntpdate -s ntp.ubuntu.com
(doesn't work)
_____________
https://klp1.com/issues/wrong-time/
Wrong system time & date - KLP1 Knowledge Base
Fix wrong time and/or date that's showing in history, logs and console
Wrong system time & date - KLP1 Knowledge Base
if chrony doesn't autostart you can add a crontab line from root account
@reboot /usr/sbin/chronyd
Wrong system time & date
SSH to the IP address of KLP1.
Login with username root and password makerbase.
Run command sudo dpkg-reconfigure tzdata and select your timezone.
Time zone should now be set correctly, now you need to enable time syncing.
Run sudo apt-get install chrony -y.
This will uninstall ntp and install chrony, a service used to sync time.s
Run timedatectl to check if the time and date are now properly synced.
mks@mkspi:~$ timedatectl
Local time: Fri 2023-11-17 21:56:55 CET
Universal time: Fri 2023-11-17 20:56:55 UTC
RTC time: Fri 2023-11-17 20:56:54
Time zone: Europe/Zagreb (CET, +0100)
System clock synchronized: yes
NTP service: inactive
RTC in local TZ: no
Comments
Change pathways
Qidi uses other paths for Klipper binaries and config in stock v10 Klipper.
You simply need to adjust those paths used by all python scripts.
Klipper config -> /home/mks/klipper_config/
Klipper binaries -> /home/mks/klipper/
Copy commands:
Copy Command to transfer stuff and generated graphs to your USB drive.
cp
cd /printer_data/config/K-ShakeTune_results/belts
cd printer_data/config/K-ShakeTune_results/
cd /home/mks/gcode_files/sda1
cp -r K-ShakeTune_results /home/mks/gcode_files/sda1/20231203
mks@mkspi:~/printer_data/config/K-ShakeTune_results/belts$ cp belts_20231126_053146.png /home/mks/gcode_files/sda1/belts_20231126_053146.png
Make WiFi work on vanilla Klipper Qidi machines with Tenda dongle and RTL8188GU chip
You have a Vanilla Klipper installed on your machine!?
To enable WiFi on the Qidi machine a kernel module has to be loaded and will manage the WiFi dongle present in your machine. Qidi machines coming with a Tenda technlogies dongle equipped with RTL8188GU chip.
Some Linux commands are required to make it work.Please dig into it and understand what it means. I will summarize the most important things here.
1) You should use a rather new version of Armbian. I use this fantastic release here:
https://github.com/redrathnure/armbian-mkspi
2) Depending on your release you have to make sure that you de-freeze your Kernel and install Kernel headers. This is required because you need usb-modeswitch. In case you install
However in case you use 0.3.4-24.2.0-trunk with an edge 6.7 Kernel all your problems are solved and you can jump to the next step.
Update your system
sudo apt-get update
Install armbian firmware
sudo apt-get install armbian-firmware-full
List your usb devices, possibly you see realtek device in "CD ROM Mode"
lsusb
Fix with usb-modeswitch
sudo apt-get install usb-modeswitch
command
sudo usb_modeswitch -KW -v 0bda -p 1a2b
If successful you see something like this:
3) Check if you have the module up and runnng. In my case it never worked.
perform: sudo armbian-config or nmtui
No wireless device is showing up here...
Also check your status from time to time with these useful commands:
lsusb
lsblk
sudo iwconfig
I loaded rtl8xxxu module with sudo lsmod | grep rtl and sudo modprobe rtl8xxxu
Still no effect. Really dont know why. It should work by now.
4) Install another driver! What worked for me is this one from wandercn. There are many other drivers available but this one is stable and fast. (Source: https://github.com/wandercn/RTL8188GU)
lsusb|grep WLANWLAN model is "RTL8188GU"
Build kernel to get linux-headers. Should be done in previous step or simply come with a suitable releas.
Install the required packages and reboot
sudo apt install -y bc build-essential git
sudo reboot
Get source code
git clone https://github.com/wandercn/RTL8188GU.git
cd RTL8188GU/8188gu-1.0.1
sudo make
sudo make install
Install the required packages and reboot
sudo apt install -y dkms bc build-essential git dh-make
sudo reboot
DKMS install
cd /usr/src
sudo git clone https://github.com/wandercn/RTL8188GU.git
sudo mv RTL8188GU/8188gu-1.0.1 8188gu-1.0.1
sudo rm -rf RTL8188GU
sudo dkms add -m 8188gu -v 1.0.1
sudo dkms build -m 8188gu -v 1.0.1
sudo dkms install -m 8188gu -v 1.0.1
check status
sudo dkms status
5) unplug/re-plug WiFi dongle !!! Most important step. Don know why but do it!
6) sudo iwconfig shows now something like this. SUCCESS!
7) For the case if it will loose the module after reboot I also added RTL8188GUXX in /etc/modules
Remarks: I still dont know why the armbian release doesen't native support this stick. In my view all requirements are met. However with this little adjustment and the driver from wandercn you have a working solution for your Xmax 3 or X Plus 3 machines.
Cartographer probe installation on vanilla Klipper
Disclamer
All actions are at your own risk. Modifying the printer in this way will invalidate the warranty! None of us are responsible for any problems associated with this manual. If you do not feel comfortable with the steps shown on this page - STOP.
Before taking any step, common sense dictates that you read the ENTIRE GUIDE before making any changes.
Abbreviations
- configuration file - /config/printer.cfg file
- macros -
- homing macro -
Introduction
From the moment I discovered Cartographer, I wanted to use it all the time. After waiting for the order and finally being at my desk, I could start the installation and configuration on my QIDI X-Max 3 with Vanilla Klipper [1], because it's always cool to have up to date software and use whatever extension/functionality you want (Spoolman! - from this point on I have a database of my stock). It was not easy, but with the help of McSneaky (he is a f*cking guru) I was able to say "It's alive! I've included all the sources at the bottom of the page if you want to dig deeper (do it - I encourage you NOT to trust me and check every point, even though the whole setup works).
To do
- set the position of the nozzle when homing to the centre of the bed (there is no effect on the bed mesh or the probe behaviour).
TL;DR
Configuration files (blue pill).
Use my configuration file and the macros [2] that works with the printer. Note that you'll have defined all the plugins I use in my setup (Spoolman, Crownest, etc). I encourage you to modify your printer files to match your setup. You have been warned.
Hardware
This article is not intended to guide you through the full installation process on the printer itself, but in a nutshell; download the probe holder model provided by McSneaky [3] (make sure you print in min. ABS/ASA - my suggestion - PC).
Software
(red pill)
Installation
Follow the official Cartographer wiki page [4]. This is straightforward and requires no change in procedure.
Configuration
This is the heart of this guide, as several things need to be modified. At first I followed the official wiki [5], but then I discovered that a few things need to be done differently.
Check your UUID (CAN version) or serial port (USB version):
USB
ls /dev/serial/by-id/CAN
~/klippy-env/bin/python ~/klipper/scripts/canbus_query.py can0[cartographer]
serial:
# Path to the serial port for the Cartographer device. Typically has the form
# /dev/serial/by-id/usb-cartographer_cartographer_...
#
# If you are using the CAN Bus version, replace serial: with canbus_uuid: and add the UUID.
# Example: canbus_uuid: 1283as878a9sd
#
speed: 40.
# Z probing dive speed.
lift_speed: 5.0
# Z probing lift speed.
backlash_comp: 0.5
# Backlash compensation distance for removing Z backlash before measuring
# the sensor response.
#
# Offsets are measured from the centre of your coil, to the tip of your nozzle
# on a level axis. It is vital that this is accurate.
#
x_offset: 0.0
# X offset of cartographer from the nozzle.
y_offset: 21.1
# Y offset of cartographer from the nozzle.
trigger_distance: 2.0
# cartographer trigger distance for homing.
trigger_dive_threshold: 1.5
# Threshold for range vs dive mode probing. Beyond `trigger_distance +
# trigger_dive_threshold` a dive will be used.
trigger_hysteresis: 0.006
# Hysteresis on trigger threshold for untriggering, as a percentage of the
# trigger threshold.
cal_nozzle_z: 0.1
# Expected nozzle offset after completing manual Z offset calibration.
cal_floor: 0.1
# Minimum z bound on sensor response measurement.
cal_ceil: 5.0
# Maximum z bound on sensor response measurement.
cal_speed: 1.0
# Speed while measuring response curve.
cal_move_speed: 10.0
# Speed while moving to position for response curve measurement.
default_model_name: default
# Name of default cartographer model to load.
mesh_main_direction: x
# Primary travel direction during mesh measurement.
#mesh_overscan: -1
# Distance to use for direction changes at mesh line ends. Omit this setting
# and a default will be calculated from line spacing and available travel.
mesh_cluster_size: 1
# Radius of mesh grid point clusters.
mesh_runs: 2
# Number of passes to make during mesh scan.
Since X-Max 3 has adxl345, I'll ignore the Input Shaper part of the configuration. The next step is to delete the [probe] section in the configuration file:
[probe]
pin: ^!MKS_THR:gpio21
x_offset: 28
y_offset: 4.4
#z_offset: 0.0
speed: 5
samples: 2
samples_result: average
sample_retract_dist: 3.0
samples_tolerance: 0.08
samples_tolerance_retries:3
Do NOT add [safe_z_home] as suggested in the Cartho wiki. We will use the [homing_override] in homing macro. It is more elegant.
[homing_override]
axes: xyz
set_position_z: 0
gcode:{% set home_all = 'X' not in params and 'Y' not in params and 'Z' not in params %} #
{% set z_hop_speed = (printer.configfile.settings['stepper_z'].homing_speed * 30) | float %} #
{% set travel_speed = (printer.toolhead.max_velocity * 30) | float %} #
{% set sensorless_variables = printer["gcode_macro _Sensorless_Homing_Variables"] %} #
{% set z_hop_distance = sensorless_variables.z_hop_distance | float %} # Collect all variables needed for sensorless homing
{% set first_homed_axis = sensorless_variables.first_homed_axis | string %} # from machine config file and _Sensorless_Homing_Variables
{% set second_homed_axis = sensorless_variables.second_homed_axis | string %} #
{% set safe_x = sensorless_variables.safe_x | float %} #
{% set safe_y = sensorless_variables.safe_y | float %} #
{% set safe_z = sensorless_variables.safe_z_enable | abs %} #{% if printer.configfile.settings.cartographer is defined %} # Check if a third-party [cartographer] definiton is used
{% set probe_name = printer.configfile.settings.cartographer %} # If [cartographer] is found in config, set 'probe_name' as [cartographer] config string{% if printer.configfile.settings.beacon is defined %} # Check if a third-party [probe] definiton is used
{% elif printer.configfile.settings.beacon is defined %} #
{% set probe_name = printer.configfile.settings.beacon %} # If [beacon] is found in config, set 'probe_name' as [beacon] config string
{% elif printer.configfile.settings.probe is defined %} #
{% set probe_name = printer.configfile.settings.probe %} # If [probe] is found in config, set 'probe_name' as [probe] config string
{% elif printer.configfile.settings.dockable_probe is defined %} #
{% set probe_name = printer.configfile.settings.dockable_probe %} # If [dockable_probe] is found in config, set 'probe_name' as [dockable_probe] config string
{% elif printer.configfile.settings.bltouch is defined %} #
{% set probe_name = printer.configfile.settings.bltouch %} # If [bltouch] is found in config, set 'probe_name' as [bltouch] config string
{% endif %} #{% if 'probe' in printer.configfile.settings.stepper_z.endstop_pin %} # Check if Z is configured to home with a probe and pull config values for
{% set probe_x_offset = probe_name.x_offset | float %} # X and Y offsets
{% set probe_y_offset = probe_name.y_offset | float %} #
{% else %} #
{% set probe_x_offset = 0 | float %} #
{% set probe_y_offset = 0 | float %} # If Z if not homed with a probe, set offsets to 0 (do not apply an offset)
{% endif %} #{% if safe_x == -128 %} #
{% set safe_x = (printer.configfile.settings.stepper_x.position_max) /2 %} # If safe_x is '-128', set safe_x to the center of the X axis
{% endif %} #{% if probe_x_offset < 0 %} #
{% set safe_x = safe_x + probe_x_offset %} #
{% elif probe_x_offset > 0 %} # Depending on if probe_x_offset is a positive or negative value, adjust safe_x
{% set safe_x = safe_x - probe_x_offset %} # If the machine does not home Z with a probe, an offset is not applied.
{% endif %} #{% if safe_y == -128 %} #
{% set safe_y = (printer.configfile.settings.stepper_y.position_max) /2 %} # If safe_y is '-128', set safe_y to the center of the Y axis
{% endif %} #{% if probe_y_offset < 0 %} #
{% set safe_y = safe_y + probe_y_offset %} #
{% elif probe_y_offset > 0 %} # Depending on if probe_y_offset is a positive or negative value, adjust safe_y
{% set safe_y = safe_y - probe_y_offset %} # If the machine does not home Z with a probe, an offset is not applied.
{% endif %} #{% if z_hop_distance > 0 %} # Check if z_hop_distance is greater than zero
{% if 'x' not in printer.toolhead.homed_axes and 'y' not in printer.toolhead.homed_axes %} # If X and Y are not homed, move Z to z_hop_distance
{% if first_homed_axis != 'Z' %}
G0 Z{z_hop_distance} F{z_hop_speed} #
{% endif %}
{% endif %} #
{% endif %} #{% if first_homed_axis == 'X' %} # If first_homed_axis is 'X', begin G28 param check
{% if home_all or 'X' in params %} #
_HOME_X # If home_all or 'X' is in params, home X
{% endif %} #
{% if home_all or 'Y' in params %} # If home_all or 'Y' in params, home Y
_HOME_Y #
{% endif %} #
{% endif %} #{% if first_homed_axis == 'Y' %} # If first_homed_axis is 'Y', begin G28 param check
{% if home_all or 'Y' in params %} #
_HOME_Y # if home_all or 'Y' is in params, home Y
{% endif %} #
{% if home_all or 'X' in params %} # If home_all or 'X' in params, home X
_HOME_X #
{% endif %} #
{% endif %} #{% if first_homed_axis == 'Z' %}
{% if home_all or 'Z' in params %}
_HOME_Z
{% endif %}
{% if second_homed_axis == 'X' %}
{% if home_all or 'X' in params %}
_HOME_X
{% endif %}
{% if home_all or 'Y' in params %}
_HOME_Y
{% endif %}
{% endif %}
{% if second_homed_axis == 'Y' %}
{% if home_all or 'Y' in params %}
_HOME_Y
{% endif %}
{% if home_all or 'X' in params %}
_HOME_X
{% endif %}
{% endif %}
{% endif %}{% if safe_z == True and (home_all or 'Z' in params) and first_homed_axis != 'Z' %} # If safe_z is true and home_all or 'Z' is in params,
G0 X{safe_x} Y{safe_y} F{travel_speed} # Move to the defined safe XY location
{% endif %} #{% if home_all or 'Z' in params %} #
{% if first_homed_axis != 'Z'%}
_HOME_Z
{% endif %}
{% endif %} #
Now let's start modifying the configuration file.
[bed_mesh]
speed: 150 # Speedspeed: 500 # Speed
horizontal_move_z: 10 # Z-axis height
mesh_min: 25,10 # Minimum position of the detection pointmesh_min: 25,20 # Minimum position of the detection point
mesh_max: 315,315 # Maximum position of the detection point
probe_count: 9,9 # Number of measuring points - 6x6 - 7x7 etc.probe_count: 15,15 # Number of measuring points - 6x6 - 7x7 etc.
algorithm: bicubic
bicubic_tension: 0.2
mesh_pps: 4, 4
When configuring the Z axis, make sure that you are using the virtual end stop:
[stepper_z]
endstop_pin: probe:z_virtual_endstop # use cartographer as virtual endstop
homing_retract_dist: 0 # cartographer needs this to be set to 0
We're almost done with the configuration part, you're one step away from success.
Let's add a [PROBE_CALIBRATE] macro in macros to make sure Klipper uses the correct calibration routine:
[gcode_macro PROBE_CALIBRATE]
gcode:
CARTOGRAPHER_CALIBRATE
Bravo! Configuration is completed, we can now calibrate our brand new Cartographer probe!
Calibration
As the official calibration is not accurate in our case, we need to do some workarounds.
Home the printer using G28 X Y.
Move to the centre of the build plate with G0 X162.5 Y162.5.
At this point we cannot follow the Cartographer wiki, as our printer slides the bed all the way down (when using G28). There is no way to compensate for this with probe calibration. We're going to trick the printer and force it to move the bed all the way down until it touches the nozzle.
First we need to enable the force_move macro in macros.
[force_move]
enable_force_move: False
enable_force_move: True
Now we are ready to SAVE_CONFIG and restart the printer.
NOTE
Now all safety limits in the Klipper configuration are DISABLED. Be aware that you need to be careful and do things slower rather than faster and for God's sake, observe the behaviour of your printer and make sure you have easy access to the OFF button on the back of the X-Max 3.
Going back to the calibration procedure, we are now forcing the printer to move [6] and Klipper will not be aware of the physical location of the nozzle. This is fine for now and we will correct this in a few ticks.
According to the official Klipper documentation [7], you must use the following syntax to force the printer to move:
FORCE_MOVE STEPPER=<config_name> DISTANCE=<value> VELOCITY=<value> [ACCEL=<value>]
My example:
FORCE_MOVE STEPPER=stepper_z DISTANCE=-1 VELOCITY=30 [ACCEL=30]
This will move Z up one millimetre. Slowly move to your Z0. G28 is moving to Z10, so you need to force the Z axis to 0, then move 10 mm down with FORCE_MOVE STEPPER=stepper_z DISTANCE=10 VELOCITY=30 [ACCEL=30] and finally Klipper will align with the physical position of your nozzle.
We can go back to the original probe calibration process.
CARTOGRAPHER_CALIBRATE
This is the time to calibrate the height between the nozzle and the bed with your favourite method (the paper supplied by QIDI is fine - it works). Then SAVE_CONFIG and reboot the printer.
For safety reasons go to macros, set enable_force_move: False then SAVE_CONFIG and restart the printer.
That is all, you can start inital tests [8].
Sources
[1] https://github.com/leadustin/QIDI-up2date-english/blob/main/Klipper-Update/update+upgrade.md
[2] https://drive.google.com/file/d/12QKo8y90gV5iahb2fZBmltBkGX8aEIRE/view?usp=sharing
[3] https://www.printables.com/pl/model/692991-qidi-x3-series-beacon-cartographer-probe-low-profi
[4] https://docs.cartographer3d.com/cartographer-probe/installation-and-setup/klipper-setup
[6] https://www.klipper3d.org/Config_Reference.html?h=pixel#force_move