Requirements

Requirements

Use this page to confirm that your printer and Klipper or Kalico configuration are compatible before installing the plugin.

Hardware

The plugin requires both of these Z references:

• A physical Z endstop that is triggered by the tip of the nozzle, similar to the standard Voron V1/V2 endstop.
• A magnetic switch-based probe mounted on the printhead, such as Annex Quickdraw Probe or Klicky Probe.

Warning: A virtual probe pin cannot be used as the Z endstop for this plugin.

The printer does not need to be a Voron, but it must use this style of nozzle-contact Z endstop.

Firmware

Supported firmware setups:

• Klipper installations that load external modules from klippy/extras.
• Kalico installations that load external plugins from klippy/plugins.

Kalico users must enable plugin overrides:

[danger_options]
allow_plugin_override: True

Unsupported probe/endstop setups:

• BLTouch-style probes.
• Beacon-style probes.
• Other non-dockable or virtual probe implementations.
• Virtual Z endstops for the Z calibration endstop.

Klipper Setup

Before configuring [z_calibration], make sure the normal printer setup is already reliable:

• Z homing works with the physical Z endstop.
• The magnetic probe attaches, docks, and triggers correctly.
• Quad gantry leveling, Z tilt, or any similar leveling routine already works if your printer uses one.
• The probe is configured as a normally closed contact. This lets macros detect whether the probe is attached or released, and lets the plugin stop before probing if the probe is not attached.

If the probe is not already reliable, fix that first. For Klicky-style probes, the Klicky Probe documentation is a good starting point. There is also a detailed example configuration from zellneralex.

Next Step

After confirming the requirements, read Known Limitations, then continue with Installation.