aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2021-11-29 16:41:48 -0500
committerKevin O'Connor <kevin@koconnor.net>2021-11-29 16:56:29 -0500
commit520273e5abfd9a3dd899f94b5df602669b655ec0 (patch)
tree7b23ace366f9931704199e2584ecbc4809167b7e /docs
parent54acca37ba642e8af4aeb9bdc6b538a639eb0320 (diff)
downloadkutter-520273e5abfd9a3dd899f94b5df602669b655ec0.tar.gz
kutter-520273e5abfd9a3dd899f94b5df602669b655ec0.tar.xz
kutter-520273e5abfd9a3dd899f94b5df602669b655ec0.zip
stepper: Support step_pulse_duration even on TMC drivers in UART/SPI mode
Commit 689231df changed the default step_pulse_duration to 100ns for TMC drivers that are configured in UART/SPI mode, but it failed to document that change in Config_Changes.md and Config_Reference.md. Update those documents to reflect that change. Update the code so that a user may specify a custom step_pulse_duration even on TMC drivers that are configured in UART/SPI mode. This may be useful for drivers that use a level shifter on the step pin that requires more than a ~300ns to detect a level change. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/Config_Changes.md7
-rw-r--r--docs/Config_Reference.md4
2 files changed, 7 insertions, 4 deletions
diff --git a/docs/Config_Changes.md b/docs/Config_Changes.md
index e91ff465..11447d4d 100644
--- a/docs/Config_Changes.md
+++ b/docs/Config_Changes.md
@@ -16,9 +16,10 @@ use the older (typically less accurate) definition, define a custom
`resistance1: 100000`, and `beta: 3950`.
20211104: The "step pulse duration" option in "make menuconfig" has
-been removed. A new `step_pulse_duration` setting in the
-[stepper config section](Config_Reference.md#stepper) should be set
-for all steppers that need a custom pulse duration.
+been removed. The default step duration for TMC drivers configured in
+UART or SPI mode is now 100ns. A new `step_pulse_duration` setting in
+the [stepper config section](Config_Reference.md#stepper) should be
+set for all steppers that need a custom pulse duration.
20211102: Several deprecated features have been removed. The stepper
`step_distance` option has been removed (deprecated on 20201222). The
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index 67d8d036..36302664 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -157,7 +157,9 @@ microsteps:
# The minimum time between the step pulse signal edge and the
# following "unstep" signal edge. This is also used to set the
# minimum time between a step pulse and a direction change signal.
-# The default is 0.000002 (which is 2us).
+# The default is 0.000000100 (100ns) for TMC steppers that are
+# configured in UART or SPI mode, and the default is 0.000002 (which
+# is 2us) for all other steppers.
endstop_pin:
# Endstop switch detection pin. If this endstop pin is on a
# different mcu than the stepper motor then it enables "multi-mcu