3diy
/
klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Minor updates to SmartEffector docs 

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2022-04-09 19:10:16 -04:00
parent 2060a6908f
commit 05330fd3e5
2 changed files with 22 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/Config_Reference.md
View File

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

25
docs/G-Codes.md
View File

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