From 391834ba12858bfa614f75c993f33cb4a51a2906 Mon Sep 17 00:00:00 2001 From: Kevin O'Connor Date: Fri, 27 Feb 2026 19:24:29 -0500 Subject: [PATCH] docs: Rework how METHOD= parameter works in G-Codes.md Describe the METHOD= parameter in the probe_eddy_current chapter. Use similar layout for both the load_cell_probe and probe_eddy_current sections. Avoid duplicating the METHOD= parmeter for other commands. Signed-off-by: Kevin O'Connor --- docs/G-Codes.md | 78 +++++++++++++++++++++++++++++++------------------ 1 file changed, 50 insertions(+), 28 deletions(-) diff --git a/docs/G-Codes.md b/docs/G-Codes.md index a4dd89fe4..f399138d1 100644 --- a/docs/G-Codes.md +++ b/docs/G-Codes.md @@ -930,10 +930,27 @@ is calibrated a force in grams is also reported. ### [load_cell_probe] -The following commands are enabled if a +The commands below are enabled if a [load_cell config section](Config_Reference.md#load_cell_probe) has been enabled. +In addition, commands that perform probes, such as [`PROBE`](#probe), +[`PROBE_ACCURACY`](#probe_accuracy), +[`BED_MESH_CALIBRATE`](#bed_mesh_calibrate) etc. will accept +additional parameters if a `[load_cell_probe]` is defined. The +parameters override the corresponding settings from the +[`[load_cell_probe]`](./Config_Reference.md#load_cell_probe) +configuration: +- `FORCE_SAFETY_LIMIT=` +- `TRIGGER_FORCE=` +- `DRIFT_FILTER_CUTOFF_FREQUENCY=` +- `DRIFT_FILTER_DELAY=<1|2>` +- `BUZZ_FILTER_CUTOFF_FREQUENCY=` +- `BUZZ_FILTER_DELAY=<1|2>` +- `NOTCH_FILTER_FREQUENCIES=` +- `NOTCH_FILTER_QUALITY=` +- `TARE_TIME=` + ### LOAD_CELL_TEST_TAP `LOAD_CELL_TEST_TAP [TAPS=] [TIMEOUT=]`: Run a testing routine that reports taps on the load cell. The toolhead will not move but the load cell @@ -944,23 +961,6 @@ QUERY_ENDSTOPS and QUERY_PROBE for load cell probes. - `TIMEOOUT`: the time, in seconds, that the tool waits for each tab before aborting. -### Load Cell Command Extensions -Commands that perform probes, such as [`PROBE`](#probe), -[`PROBE_ACCURACY`](#probe_accuracy), -[`BED_MESH_CALIBRATE`](#bed_mesh_calibrate) etc. will accept additional -parameters if a `[load_cell_probe]` is defined. The parameters override the -corresponding settings from the -[`[load_cell_probe]`](./Config_Reference.md#load_cell_probe) configuration: -- `FORCE_SAFETY_LIMIT=` -- `TRIGGER_FORCE=` -- `DRIFT_FILTER_CUTOFF_FREQUENCY=` -- `DRIFT_FILTER_DELAY=<1|2>` -- `BUZZ_FILTER_CUTOFF_FREQUENCY=` -- `BUZZ_FILTER_DELAY=<1|2>` -- `NOTCH_FILTER_FREQUENCIES=` -- `NOTCH_FILTER_QUALITY=` -- `TARE_TIME=` - ### [manual_probe] The manual_probe module is automatically loaded. @@ -1183,25 +1183,23 @@ The following commands are available when a see the [probe calibrate guide](Probe_Calibrate.md)). #### PROBE -`PROBE [METHOD=] [PROBE_SPEED=] [LIFT_SPEED=] -[SAMPLES=] [SAMPLE_RETRACT_DIST=] [SAMPLES_TOLERANCE=] +`PROBE [PROBE_SPEED=] [LIFT_SPEED=] [SAMPLES=] +[SAMPLE_RETRACT_DIST=] [SAMPLES_TOLERANCE=] [SAMPLES_TOLERANCE_RETRIES=] [SAMPLES_RESULT=median|average]`: Move the nozzle downwards until the probe triggers. If any of the optional parameters are provided they override their equivalent setting in the [probe config section](Config_Reference.md#probe). -The optional parameter `METHOD` is probe-specific. #### QUERY_PROBE `QUERY_PROBE`: Report the current status of the probe ("triggered" or "open"). #### PROBE_ACCURACY -`PROBE_ACCURACY [METHOD=] [PROBE_SPEED=] [SAMPLES=] +`PROBE_ACCURACY [PROBE_SPEED=] [SAMPLES=] [SAMPLE_RETRACT_DIST=]`: Calculate the maximum, minimum, average, median, and standard deviation of multiple probe samples. By default, 10 SAMPLES are taken. Otherwise the optional parameters default to their equivalent setting in the probe config section. -The optional parameter `METHOD` is probe-specific. #### PROBE_CALIBRATE `PROBE_CALIBRATE [SPEED=] [=]`: Run a @@ -1220,10 +1218,36 @@ Requires a `SAVE_CONFIG` to take effect. ### [probe_eddy_current] -The following commands are available when a +The commands below are available when a [probe_eddy_current config section](Config_Reference.md#probe_eddy_current) is enabled. +In addition, commands that perform probes, such as [`PROBE`](#probe), +[`PROBE_ACCURACY`](#probe_accuracy), +[`BED_MESH_CALIBRATE`](#bed_mesh_calibrate) etc. will accept +additional parameters if a `[probe_eddy_current]` section is defined: +- `METHOD=`: This alters the probing mechanism: + - `METHOD=scan`: The toolhead does not descend. Instead the toolhead + will pause briefly above each target location and return the + measured height at that position. + - `METHOD=rapid_scan`: The toolhead does not descend and does not + pause at each target location. The value returned is the measured + height around the time that the toolhead was near each target + position. + - `METHOD=tap`: The toolhead will descend until the nozzle makes + contact with the bed. This method is only available if + `tap_threshold` is specified in the `[probe_eddy_current]` config + section. + - default: If no `METHOD` parameter is specified then the default + behavior is for the toolhead to descend until the sensor detects + that the distance to the bed is at or below the `z_offset` + parameter specified in the `[probe_eddy_current]` config section. +- `SAMPLE_TIME=