⚙️Settings & Commands
Last Updated: December 7th 2024
Available Commands
PROBE_SWITCH
PROBE_SWITCHUsing this allows you to easily swap between SCAN and TOUCH modes. You will be prompted to SAVE_CONFIGupon completing this command.
CARTOGRAPHER_CALIBRATE
CARTOGRAPHER_CALIBRATEThis commands for both TOUCH and SCAN modes. Users dont need to explicitly set which mode as it will be defined by modeunder your printer.cfg [scanner]OR if default, will be scan mode.
SCAN MODE
Will prompt users to do the paper method of lowering the nozzle to the bed, before calibration
TOUCH MODE
This will initiate touch mode calibration and should only be for re-calibrating not initial setup.
Available Parameters
METHOD = MANUAL
METHOD = MANUALInitiates the manual paper test for creating an initial scanner mode.
SPEED =
SPEED =Specifies the speed at which the probing move is executed.
Default: 3
Constraints: Cannot exceed 5.
ACCEL =
ACCEL =Sets the acceleration used during the touch operation.
Default: 100
Constraints: Must be greater than or equal to 100.
RETRACT =
RETRACT =Determines the distance the toolhead retracts after a probe.
Default: 2
Constraints: Must be at least 1.
RETRACT_SPEED =
RETRACT_SPEED =Sets the speed for the retraction move after probing.
Default: 10
Constraints: Must be at least 1.
SAMPLES =
SAMPLES =Defines the number of samples to take during the touch operation.
Default: 3
Constraints: Must be at least 1.
TOLERANCE =
TOLERANCE =Sets the tolerance level for the touch samples.
Default: 0.01
Constraints: Must be above 0.0
RETRIES =
RETRIES =Specifies the maximum number of retries allowed if samples exceed the tolerance.
Default: 10
Constraints: Must be at least 0.
THRESHOLD =
THRESHOLD =Defines the threshold value used for detecting a touch during probing.
Default: 2500 or scanner_touch_threshold in printer.cfg
Constraints: Must be at least 100; can be found via
CARTOGRAPHER_THRESHOLD_SCAN
DEBUG = 1
DEBUG = 1Enables or disables debug mode, which controls the verbosity of logging and information output during the touch operation.
Default: 0 (debugging off)
Constraints: 0 if off, 1 is on.
This will enabled debugging information. Its useful for showing information relevant to how touch height is calculated. If you encounter issues, this is what you should provide in discord alongside klippy.log
CARTOGRAPHER_TOUCH
CARTOGRAPHER_TOUCHThe CARTOGRAPHER_TOUCH command is designed to initiate a probing process. This will then attempt to bring the nozzle to the bed and measure this for repeatability. This ensures a perfect first layer if configured correctly.
Detailed Explanation
Key Functions:
Configuration and Initialization:
The command starts by pulling various parameters either from the command itself, or falling back on default values defined in the printer's configuration (printer.cfg).
Parameters include speed, acceleration, retraction distances, number of samples, tolerance levels, and the specific location (X and Y coordinates) where the probing will occur.
Mode Selection:
The command operates in Touch Mode, which uses a physical touch sensor to detect contact with the surface.
The mode is determined by the
modeconfiguration in printer.cfg, and the command ensures that touch mode is selected.
Safety and Validation Checks:
Before proceeding, the command ensures that the X and Y axes are homed (i.e., the machine knows their precise positions).
If the axes are not homed, the command raises an error, preventing the probing process from proceeding.
Probing Process:
The toolhead is moved to the specified touch location (X, Y coordinates).
The probing process begins, collecting multiple samples to determine the exact position.
The process accounts for factors such as acceleration, speed, retraction distance, and retries if the tolerance levels are not met.
If the
manualmethod is specified, a manual calibration process (paper test) is initiated instead of the automated touch process.
Result Handling:
Once the probing process is completed, the results (e.g., final position, standard deviation of the samples) are logged and displayed.
If the probing is successful, the results are used to calibrate the system, adjusting the Z-offset or other calibration parameters as needed.
If the probing fails, an error message is provided, and no calibration is applied.
Logging and Debugging:
The command supports a debug mode that logs detailed information about the probing process, including all the parameters used and the results obtained.
This is useful for troubleshooting and ensuring the probing process is functioning correctly.
Use Cases:
Bed Leveling: Ensures that the print bed is perfectly level by detecting any variations in height across different points on the bed.
Z-Offset Calibration: Adjusts the Z-axis offset to ensure the nozzle is at the correct distance from the print bed for optimal printing.
Probing Accuracy: Verifies the precision and repeatability of the probing process, ensuring consistent results.
Available Parameters
SPEED =
SPEED =Specifies the speed at which the probing move is executed.
Default: 3
Constraints: Cannot exceed 5.
ACCEL =
ACCEL =Sets the acceleration used during the touch operation.
Default: 100
Constraints: Must be greater than or equal to 100.
RETRACT =
RETRACT =Determines the distance the toolhead retracts after a probe.
Default: 2
Constraints: Must be at least 1.
RETRACT_SPEED =
RETRACT_SPEED =Sets the speed for the retraction move after probing.
Default: 10
Constraints: Must be at least 1.
SAMPLES =
SAMPLES = Defines the number of samples to take during the touch operation.
Default: 3
Constraints: Must be at least 1.
TOLERANCE =
TOLERANCE = Sets the tolerance level for the touch samples.
Default: 0.01
Constraints: Must be above 0.0.
RETRIES =
RETRIES = Specifies the maximum number of retries allowed if samples exceed the tolerance.
Default: 3
Constraints: Must be at least 0.
FUZZY =
FUZZY = Specifies the value that will be used to create a bounding box for touch movements to move around in if attempting multiple touches. A value inside this box will be randomly selected so you don't keep touching the same location.
Default Value: 0
Constraints: MAX is 10
THRESHOLD =
THRESHOLD = Defines the threshold value used for detecting a touch during probing.
Default: 2500 or scanner_touch_threshold in printer.cfg
Constraints: Must be at least 100; can be found via
CARTOGRAPHER_THRESHOLD_SCAN
DEBUG = 1
DEBUG = 1Enables or disables debug mode, which controls the verbosity of logging and information output during the touch operation.
Default: 0 (debugging off)
Constraints: 0 if off, 1 is on.
This will enabled debugging information. Its useful for showing information relevant to how touch height is calculated. If you encounter issues, this is what you should provide in discord alongside klippy.log
CARTOGRAPHER_THRESHOLD_SCAN
CARTOGRAPHER_THRESHOLD_SCANThe CARTOGRAPHER_THRESHOLD_SCAN command is used to scan a range of threshold values to find the most consistent and reliable threshold for the touch sensor. This function performs a series of probe tests across different threshold values, evaluating the consistency of each threshold until it finds the best one that meets the specified criteria.
Detailed Explanation
Process
Threshold Scanning
The scan starts by setting the trigger method to touch and initializing the current threshold to the minimum value (
MIN).The function then enters a loop where it tests each threshold value, increasing by the step size (
STEP) until the maximum threshold (MAX) is reached.
Threshold Qualification
For each threshold value, a series of probe tests (
QUALIFY_SAMPLES) are conducted.The results are evaluated to see if they meet the acceptable range value.
Threshold Verification
If a threshold value shows promising consistency during qualification, it is further verified with an additional set of probe tests (
VERIFY_SAMPLES).The threshold is evaluated for quality based on the consistency of the results.
Finalization
If a threshold value is found that meets or exceeds the target consistency, it is considered the best threshold.
If this threshold is different from the original, it is saved for future use.
Logging Results
Throughout the process, the function logs information about the testing of each threshold, including whether it passed qualification and verification.
At the end of the scan, the best threshold value is logged along with its quality level and range.
Available Parameters
MIN =
MIN =Purpose: Defines the minimum threshold value for starting the scan.
Default: 500
Constraints: Must be atleast 100 and less than MAX.
MAX =
MAX =Defines the maximum threshold value for ending the scan.
Default: 5000
Constraints: Must be greater than MIN.
STEP =
STEP =Specifies the increment by which the threshold is increased during the scan.
Default: 250
Constraints: Must be a positive number.
SKIP =
SKIP =Indicates the number of initial samples to skip when evaluating thresholds.
Default: 1
Constraints: Must be a positive number.
QUALIFY_SAMPLES =
QUALIFY_SAMPLES =The number of samples used to initially qualify a threshold.
Default: 5
Constraints: Must be greater than or equal to SKIP.
VERIFY_SAMPLES =
VERIFY_SAMPLES =The number of samples used to verify a threshold that shows promise during qualification.
Default: 5
Constraints: Must be a positive number.
TOLERANCE =
TOLERANCE =Sets the tolerance level for the touch samples.
Default: 0.01
Constraints: Must be above 0.0.
Available Printer.cfg Settings
These shouldn't be needed to changed, however they are available.
Available Settings
sensor
Default: cartographer
sensor_alt
Default: carto
speed
Default: 5.0
Constraint: above 0.0
lift_speed
Default: Value of
speedConstraint: above 0.0
backlash_comp
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.
Default: 0.5
mesh_runs:
Number of passes to make during mesh scan.
Default: 1
Constraint: Must be above 0.
mesh_main_direction
Primary direction of travel while running a bed mesh
Default: x
Constraint: X or Y
probe_speed
Default: 5.0
samples
Default: 5
Constraint: above 0.0
samples_retract_dist
Default: 5.0
Constraint: above 0.0
samples_tolerance
Default: 0.2
Constraint: min 0.0
samples_tolerance_retries
Default: 4
Constraint: min 0
samples_result
Default: "median"
Available Options: median or average
x_offset
X offset of cartographer from the nozzle.
Default: 0.0
y_offset
Y offset of cartographer from the nozzle.
Default: 0.0
z_hop_dist
Default: 5.0
Constraint: above 0.0
z_hop_speed
Default: 5.0
Constraint: above 0.0
mode
Default: "scan"
Available options: touch or scan
trigger_distance
Cartographer trigger distance for homing.
Default: 2.0
trigger_dive_threshold
Threshold for range vs dive mode probing. Beyond `trigger_distance + trigger_dive_threshold` a dive will be used.
Default: 1.5
trigger_hysteresis
Hysteresis on trigger threshold for untriggering, as a percentage of the
trigger threshold.
Default: 0.006
z_settling_time
Default: 5 seconds
Constraint: min 0
scanner_touch_accel
Default: 100
Constraint: above 0, min 100
scanner_touch_max_speed
Default: 10
Constraint: above 0, max 30
scanner_touch_speed
Default: 3
Constraint: max scanner_touch_max_speed
scanner_touch_retract_dist
Default: 2
Constraint: min 1
scanner_touch_retract_speed
Default: 10
Constraint: min 1
scanner_touch_sample_count
Default: 3
Constraint: min 1
scanner_touch_tolerance
Default: 0.008
Constraint: above 0.0
scanner_touch_max_retries
Default: 10
Constraint: min 0
scanner_touch_move_speed
Default: 50
Constraint: min 1
scanner_touch_z_offset
Default: 0.05
scanner_touch_max_temp
Default: 150
Nozzle touching temperature must be below this limit. In Celsius
scanner_touch_threshold
Default: 2500
Last updated