aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Config_Reference.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2021-08-21 22:05:53 -0400
committerKevin O'Connor <kevin@koconnor.net>2022-03-29 20:34:46 -0400
commitaec742ece4589aa857926c16649a3be358a57c44 (patch)
treee980e410fb7efbc93e0a502d8f5cb20c85c792ce /docs/Config_Reference.md
parent74937326d313ae741c42207035ebcf8c09aa9e01 (diff)
downloadkutter-aec742ece4589aa857926c16649a3be358a57c44.tar.gz
kutter-aec742ece4589aa857926c16649a3be358a57c44.tar.xz
kutter-aec742ece4589aa857926c16649a3be358a57c44.zip
angle: Initial support for angle sensor calibration
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Config_Reference.md')
-rw-r--r--docs/Config_Reference.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index 0add9aed..7fca3797 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -4007,6 +4007,7 @@ Magnetic hall angle sensor support for reading stepper motor angle
shaft measurements using a1333, as5047d, or tle5012b SPI chips. The
measurements are available via the [API Server](API_Server.md) and
[motion analysis tool](Debugging.md#motion-analysis-and-data-logging).
+See the [G-Code reference](G-Codes.md#angle) for available commands.
```
[angle my_angle_sensor]
@@ -4017,6 +4018,12 @@ sensor_type:
#sample_period: 0.000400
# The query period (in seconds) to use during measurements. The
# default is 0.000400 (which is 2500 samples per second).
+#stepper:
+# The name of the stepper that the angle sensor is attached to (eg,
+# "stepper_x"). Setting this value enables an angle calibration
+# tool. To use this feature, the Python "numpy" package must be
+# installed. The default is to not enable angle calibration for the
+# angle sensor.
cs_pin:
# The SPI enable pin for the sensor. This parameter must be provided.
#spi_speed: