aboutsummaryrefslogtreecommitdiffstats
path: root/docs/G-Codes.md
diff options
context:
space:
mode:
authorDmitry Butyugin <dmbutyugin@google.com>2021-09-06 02:33:16 +0200
committerKevinOConnor <kevin@koconnor.net>2022-04-09 19:04:57 -0400
commit2060a6908fddde86395990f310188af03b299417 (patch)
tree29b35c43542f88f7e1b0816269043d8b8434afa1 /docs/G-Codes.md
parent76b22b3125d3201baef7d157d0fc7fb2d9d6704c (diff)
downloadkutter-2060a6908fddde86395990f310188af03b299417.tar.gz
kutter-2060a6908fddde86395990f310188af03b299417.tar.xz
kutter-2060a6908fddde86395990f310188af03b299417.zip
smart_effector: Config and command reference
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
Diffstat (limited to 'docs/G-Codes.md')
-rw-r--r--docs/G-Codes.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 80a99d3f..b617608c 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -1053,6 +1053,34 @@ profile matching the supplied name from persistent memory. Note that
after SAVE or REMOVE operations have been run the SAVE_CONFIG gcode
must be run to make the changes to persistent memory permanent.
+### [smart_effector]
+
+Several commands are available when a
+[smart_effector config section](Config_Reference.md#smart-effector) is enabled.
+Be sure to check the official documentation for the Smart Effector on the
+[Duet3D Wiki](https://duet3d.dozuki.com/Wiki/Smart_effector_and_carriage_adapters_for_delta_printer)
+before changing the Smart Effector parameters. Also check the
+[probe calibration guide](Probe_Calibrate.md).
+
+#### SET_SMART_EFFECTOR
+`SET_SMART_EFFECTOR [SENSITIVITY=<sensitivity>] [ACCEL=<accel>]
+[RECOVERY_TIME=<time>]`: Set the Smart Effector parameters. When `SENSITIVITY`
+is specified, the respective value is written to the SmartEffector EEPROM
+(requires `control_pin` to be provided). Acceptable <sensitivity> values are
+0..255, the default is 50. Lower values require less nozzle contact force to
+trigger (but there is a higher risk of false triggering due to vibrations
+during probing), and higher values reduce false triggering (but require larger
+contact force to trigger). Since the sensitivity is written to EEPROM, it is
+preserved after the shutdown, and so it does not need to be configured on
+every printer startup. `ACCEL` and `RECOVERY_TIME` allow to override the
+corresponding parameters at run-time, see the
+[config section](Config_Reference.md#smart-effector) of Smart Effector for
+more info on those parameters.
+
+#### RESET_SMART_EFFECTOR
+`RESET_SMART_EFFECTOR`: Resets Smart Effector sensitivity to its factory
+settings. Requires `control_pin` to be provided in the config section.
+
### [stepper_enable]
The stepper_enable module is automatically loaded.