smart_effector: Config and command reference

Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
This commit is contained in:
Dmitry Butyugin 2021-09-06 02:33:16 +02:00 committed by KevinOConnor
parent 76b22b3125
commit 2060a6908f
2 changed files with 80 additions and 0 deletions

View file

@ -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.