From 4046b34a7baf5612486cff7eba46a06b950e80d3 Mon Sep 17 00:00:00 2001 From: Kevin O'Connor Date: Tue, 3 Mar 2026 19:21:52 -0500 Subject: [PATCH] docs: Note probe options that can change via G-Code in Config_Reference.md Signed-off-by: Kevin O'Connor --- docs/Config_Reference.md | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md index 50b1b30ac..55638c55d 100644 --- a/docs/Config_Reference.md +++ b/docs/Config_Reference.md @@ -2137,32 +2137,44 @@ z_offset: # The distance (in mm) between the bed and the nozzle when the probe # triggers. This parameter must be provided. #speed: 5.0 -# Speed (in mm/s) of the Z axis when probing. The default is 5mm/s. +# Speed (in mm/s) of the Z axis when probing. It may be possible to +# change this value at runtime via a "PROBE_SPEED" command +# parameter. The default is 5mm/s. #samples: 1 # The number of times to probe each point. The probed z-values will -# be averaged. The default is to probe 1 time. +# be averaged. It may be possible to change this value at runtime +# via a "SAMPLES" command parameter. The default is to probe 1 time. #sample_retract_dist: 2.0 # The distance (in mm) to lift the toolhead between each sample (if -# sampling more than once). The default is 2mm. +# sampling more than once). It may be possible to change this value +# at runtime via a "SAMPLE_RETRACT_DIST" command parameter. The +# default is 2mm. #lift_speed: # Speed (in mm/s) of the Z axis when lifting the probe between -# samples. The default is to use the same value as the 'speed' -# parameter. +# samples. It may be possible to change this value at runtime via a +# "LIFT_SPEED" command parameter. The default is to use the same +# value as the 'speed' parameter. #samples_result: average # The calculation method when sampling more than once - either -# "median" or "average". The default is average. +# "median" or "average". It may be possible to change this value at +# runtime via a "SAMPLES_RESULT" command parameter. The default is +# average. #samples_tolerance: 0.100 # The maximum Z distance (in mm) that a sample may differ from other # samples. If this tolerance is exceeded then either an error is # reported or the attempt is restarted (see -# samples_tolerance_retries). The default is 0.100mm. +# samples_tolerance_retries). It may be possible to change this +# value at runtime via a "SAMPLES_TOLERANCE" command parameter. The +# default is 0.100mm. #samples_tolerance_retries: 0 # The number of times to retry if a sample is found that exceeds # samples_tolerance. On a retry, all current samples are discarded # and the probe attempt is restarted. If a valid set of samples are # not obtained in the given number of retries then an error is -# reported. The default is zero which causes an error to be reported -# on the first sample that exceeds samples_tolerance. +# reported. It may be possible to change this value at runtime via a +# "SAMPLES_TOLERANCE_RETRIES" command parameter. The default is zero +# which causes an error to be reported on the first sample that +# exceeds samples_tolerance. #activate_gcode: # A list of G-Code commands to execute prior to each probe attempt. # See docs/Command_Templates.md for G-Code format. This may be