diff options
| author | Eric Callahan <arksine.code@gmail.com> | 2024-04-09 11:26:39 -0400 |
|---|---|---|
| committer | KevinOConnor <kevin@koconnor.net> | 2024-07-17 22:25:49 -0400 |
| commit | 6848843224009df3594efbaf3a4c3acc2de107e2 (patch) | |
| tree | 52aa829ec8813c827b3f898547ad31a7774697d7 /docs/G-Codes.md | |
| parent | bd1dbc8af341bdaafc480d5363471937337c2af1 (diff) | |
| download | kutter-6848843224009df3594efbaf3a4c3acc2de107e2.tar.gz kutter-6848843224009df3594efbaf3a4c3acc2de107e2.tar.xz kutter-6848843224009df3594efbaf3a4c3acc2de107e2.zip | |
docs: add initial temperature_probe documentation
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
Diffstat (limited to 'docs/G-Codes.md')
| -rw-r--r-- | docs/G-Codes.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md index e55fba35..2444c53b 100644 --- a/docs/G-Codes.md +++ b/docs/G-Codes.md @@ -1415,3 +1415,39 @@ command will probe the points specified in the config and then make independent adjustments to each Z stepper to compensate for tilt. See the PROBE command for details on the optional probe parameters. The optional `HORIZONTAL_MOVE_Z` value overrides the `horizontal_move_z` option specified in the config file. + +### [temperature_probe] + +The following commands are available when a +[temperature_probe config section](Config_Reference.md#temperature_probe) +is enabled. + +#### TEMPERATURE_PROBE_CALIBRATE +`TEMPERATURE_PROBE_CALIBRATE [PROBE=<probe name>] [TARGET=<value>] [STEP=<value>]`: +Initiates probe drift calibration for eddy current based probes. The `TARGET` +is a target temperature for the last sample. When the temperature recorded +during a sample exceeds the `TARGET` calibration will complete. The `STEP` +parameter sets temperature delta (in C) between samples. After a sample has +been taken, this delta is used to schedule a call to `TEMPERATURE_PROBE_NEXT`. +The default `STEP` is 2. + +#### TEMPERATURE_PROBE_NEXT +`TEMPERATURE_PROBE_NEXT`: After calibration has started this command is run to +take the next sample. It is automatically scheduled to run when the delta +specified by `STEP` has been reached, however its also possible to manually run +this command to force a new sample. This command is only available during +calibration. + +#### TEMPERATURE_PROBE_COMPLETE: +`TEMPERATURE_PROBE_COMPLETE`: Can be used to end calibration and save the +current result before the `TARGET` temperature is reached. This command +is only available during calibration. + +#### ABORT +`ABORT`: Aborts the calibration process, discarding the current results. +This command is only available during drift calibration. + +### TEMPERATURE_PROBE_ENABLE +`TEMPERATURE_PROBE_ENABLE ENABLE=[0|1]`: Sets temperature drift +compensation on or off. If ENABLE is set to 0, drift compensation +will be disabled, if set to 1 it is enabled. |