aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Config_Reference.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Config_Reference.md')
-rw-r--r--docs/Config_Reference.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index 70807e7d..f297dbdc 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -1746,6 +1746,58 @@ control_pin:
# See the "probe" section for information on these parameters.
```
+### [smart_effector]
+Smart Effector. One may define this section instead of `[probe]` to enable
+the SmartEffector-specific features. This also enables
+[runtime commands](G-Codes.md#smart-effector) to adjust the parameters of
+the Smart Effector at run time.
+
+```
+[smart_effector]
+pin:
+# Pin connected to the Smart Effector Z Probe output pin (pin 5). Note that
+# pullup resistor on the board is generally not required. However, if the
+# output pin is connected to the board pin with a pullup resistor, that
+# resistor must be high value (e.g. 10K Ohm or more). Some boards have a low
+# value pullup resistor on the Z probe input, which will likely result in an
+# always-triggered probe state. In this case, connect the Smart Effector to
+# a different pin on the board. This parameter is required.
+# control_pin:
+# Pin connected to the Smart Effector control input pin (pin 7). If provided,
+# Smart Effector sensitivity programming commands become available.
+# probe_accel:
+# If set, limits the acceleration of the probing moves (in mm/sec^2).
+# A sudden large acceleration at the beginning of the probing move may
+# cause spurious probe triggering, especially if the hotend is heavy.
+# To prevent that, it may be necessary to reduce the acceleration of
+# the probing moves via this parameter.
+# recovery_time: 0.4
+# A delay between the travel moves and the probing moves in seconds. A fast
+# travel move prior to probing may result in a spurious probe triggering.
+# This may cause 'Probe triggered prior to movement' errors if no delay
+# is set. Value 0 disables the recovery delay.
+# Default value is 0.4.
+#x_offset:
+#y_offset:
+# Should be left unset (or set to 0).
+z_offset:
+# Trigger height of the probe. Start with -0.1 (mm), and adjust later using
+# `PROBE_CALIBRATE` command. This parameter must be provided.
+#speed:
+# Speed (in mm/s) of the Z axis when probing. It is recommended to start
+# with the probing speed of 20 mm/s and adjust it as necessary to improve
+# the accuracy and repeatability of the probe triggering.
+#samples:
+#sample_retract_dist:
+#samples_result:
+#samples_tolerance:
+#samples_tolerance_retries:
+#activate_gcode:
+#deactivate_gcode:
+#deactivate_on_each_sample:
+# See the "probe" section for more information on the parameters above.
+```
+
## Additional stepper motors and extruders
### [stepper_z1]