aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Config_Reference.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2021-11-28 22:01:26 -0500
committerKevin O'Connor <kevin@koconnor.net>2021-12-12 12:44:06 -0500
commit323268ea02700b2fd3b6accda310845ba29c894e (patch)
treeecb36cfd7bef0265d20c1ae72212e68dc4040e28 /docs/Config_Reference.md
parent92c41b88278ba571a0ef3303e9fedc686aacaeef (diff)
downloadkutter-323268ea02700b2fd3b6accda310845ba29c894e.tar.gz
kutter-323268ea02700b2fd3b6accda310845ba29c894e.tar.xz
kutter-323268ea02700b2fd3b6accda310845ba29c894e.zip
docs: Note systemic error introduced by interpolate setting in TMC_Drivers.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Config_Reference.md')
-rw-r--r--docs/Config_Reference.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index 75a9de52..589deb83 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -2767,7 +2767,9 @@ cs_pin:
# The default is to not use an SPI daisy chain.
#interpolate: True
# If true, enable step interpolation (the driver will internally
-# step at a rate of 256 micro-steps). The default is True.
+# step at a rate of 256 micro-steps). This interpolation does
+# introduce a small systemic positional deviation - see
+# TMC_Drivers.md for details. The default is True.
run_current:
# The amount of current (in amps RMS) to configure the driver to use
# during stepper movement. This parameter must be provided.
@@ -2834,7 +2836,9 @@ uart_pin:
# UART communication. The default is to not configure any pins.
#interpolate: True
# If true, enable step interpolation (the driver will internally
-# step at a rate of 256 micro-steps). The default is True.
+# step at a rate of 256 micro-steps). This interpolation does
+# introduce a small systemic positional deviation - see
+# TMC_Drivers.md for details. The default is True.
run_current:
# The amount of current (in amps RMS) to configure the driver to use
# during stepper movement. This parameter must be provided.
@@ -2946,7 +2950,9 @@ cs_pin:
#interpolate: True
# If true, enable step interpolation (the driver will internally
# step at a rate of 256 micro-steps). This only works if microsteps
-# is set to 16. The default is True.
+# is set to 16. Interpolation does introduce a small systemic
+# positional deviation - see TMC_Drivers.md for details. The default
+# is True.
run_current:
# The amount of current (in amps RMS) used by the driver during
# stepper movement. This parameter must be provided.