aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2024-01-07 23:53:57 -0500
committerKevin O'Connor <kevin@koconnor.net>2024-04-09 16:32:43 -0400
commit30e0fddbbf3957dfae696bdc739dfb4a0ad83016 (patch)
tree274ffddb4c1e823117f34027869ad3fc539104f8 /docs
parent28281c595b6be72b5085266b39e3401858b4c0cb (diff)
downloadkutter-30e0fddbbf3957dfae696bdc739dfb4a0ad83016.tar.gz
kutter-30e0fddbbf3957dfae696bdc739dfb4a0ad83016.tar.xz
kutter-30e0fddbbf3957dfae696bdc739dfb4a0ad83016.zip
docs: Add documentation for probe_eddy_current
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/Config_Reference.md34
-rw-r--r--docs/G-Codes.md22
2 files changed, 56 insertions, 0 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index 1b833eaf..4999aba5 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -1995,6 +1995,40 @@ z_offset:
# See the "probe" section for more information on the parameters above.
```
+### [probe_eddy_current]
+
+Support for eddy current inductive probes. One may define this section
+(instead of a probe section) to enable this probe. See the
+[command reference](G-Codes.md#probe_eddy_current) for further information.
+
+```
+[probe_eddy_current my_eddy_probe]
+sensor_type: ldc1612
+# The sensor chip used to perform eddy current measurements. This
+# parameter must be provided and must be set to ldc1612.
+#z_offset:
+# The nominal distance (in mm) between the nozzle and bed that a
+# probing attempt should stop at. This parameter must be provided.
+#i2c_address:
+#i2c_mcu:
+#i2c_bus:
+#i2c_software_scl_pin:
+#i2c_software_sda_pin:
+#i2c_speed:
+# The i2c settings for the sensor chip. See the "common I2C
+# settings" section for a description of the above parameters.
+#x_offset:
+#y_offset:
+#speed:
+#lift_speed:
+#samples:
+#sample_retract_dist:
+#samples_result:
+#samples_tolerance:
+#samples_tolerance_retries:
+# See the "probe" section for information on these parameters.
+```
+
### [axis_twist_compensation]
A tool to compensate for inaccurate probe readings due to twist in X gantry. See
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 0b8aa6e5..e55fba35 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -984,6 +984,28 @@ babystepping), and subtract if from the probe's z_offset. This acts
to take a frequently used babystepping value, and "make it permanent".
Requires a `SAVE_CONFIG` to take effect.
+### [probe_eddy_current]
+
+The following commands are available when a
+[probe_eddy_current config section](Config_Reference.md#probe_eddy_current)
+is enabled.
+
+#### PROBE_EDDY_CURRENT_CALIBRATE
+`PROBE_EDDY_CURRENT_CALIBRATE CHIP=<config_name>`: This starts a tool
+that calibrates the sensor resonance frequencies to corresponding Z
+heights. The tool will take a couple of minutes to complete. After
+completion, use the SAVE_CONFIG command to store the results in the
+printer.cfg file.
+
+#### LDC_CALIBRATE_DRIVE_CURRENT
+`LDC_CALIBRATE_DRIVE_CURRENT CHIP=<config_name>` This tool will
+calibrate the ldc1612 DRIVE_CURRENT0 register. Prior to using this
+tool, move the sensor so that it is near the center of the bed and
+about 20mm above the bed surface. Run this command to determine an
+appropriate DRIVE_CURRENT for the sensor. After running this command
+use the SAVE_CONFIG command to store that new setting in the
+printer.cfg config file.
+
### [pwm_cycle_time]
The following command is available when a