diff options
author | Kevin O'Connor <kevin@koconnor.net> | 2022-04-09 19:10:16 -0400 |
---|---|---|
committer | Kevin O'Connor <kevin@koconnor.net> | 2022-04-09 19:10:16 -0400 |
commit | 05330fd3e5ba45a8a694f16fd2e4863858133a51 (patch) | |
tree | 7a992134e8bba7ba5660635a5900e6e65ec745df /docs | |
parent | 2060a6908fddde86395990f310188af03b299417 (diff) | |
download | kutter-05330fd3e5ba45a8a694f16fd2e4863858133a51.tar.gz kutter-05330fd3e5ba45a8a694f16fd2e4863858133a51.tar.xz kutter-05330fd3e5ba45a8a694f16fd2e4863858133a51.zip |
docs: Minor updates to SmartEffector docs
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Config_Reference.md | 16 | ||||
-rw-r--r-- | docs/G-Codes.md | 25 |
2 files changed, 22 insertions, 19 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md index f297dbdc..cc44f0ad 100644 --- a/docs/Config_Reference.md +++ b/docs/Config_Reference.md @@ -1747,10 +1747,12 @@ control_pin: ``` ### [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. + +The "Smart Effector" from Duet3d implements a Z probe using a force +sensor. One may define this section instead of `[probe]` to enable the +Smart Effector 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] @@ -1762,16 +1764,16 @@ pin: # 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: +#control_pin: # Pin connected to the Smart Effector control input pin (pin 7). If provided, # Smart Effector sensitivity programming commands become available. -# probe_accel: +#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 +#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 diff --git a/docs/G-Codes.md b/docs/G-Codes.md index b617608c..a83c5c84 100644 --- a/docs/G-Codes.md +++ b/docs/G-Codes.md @@ -1064,18 +1064,19 @@ before changing the Smart Effector parameters. Also check the #### 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. +[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 |