aboutsummaryrefslogtreecommitdiffstats
path: root/docs/G-Codes.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/G-Codes.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/G-Codes.md')
-rw-r--r--docs/G-Codes.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 34234bfa..131ee6e8 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -106,6 +106,27 @@ VAL=<value>`: Writes raw "value" into a register "register". Both
"value" and "register" can be a decimal or a hexadecimal integer. Use
with care, and refer to ADXL345 data sheet for the reference.
+### [angle]
+
+The following commands are available when an
+[angle config section](Config_Reference.md#angle) is enabled.
+
+#### ANGLE_CALIBRATE
+`ANGLE_CALIBRATE CHIP=<chip_name>`: Perform angle calibration on the
+given sensor (there must be an `[angle chip_name]` config section that
+has specified a `stepper` parameter). IMPORTANT - this tool will
+command the stepper motor to move without checking the normal
+kinematic boundary limits. Ideally the motor should be disconnected
+from any printer carriage before performing calibration. If the
+stepper can not be disconnected from the printer, make sure the
+carriage is near the center of its rail before starting calibration.
+(The stepper motor may move forwards or backwards two full rotations
+during this test.) After completing this test use the `SAVE_CONFIG`
+command to save the calibration data to the config file. In order to
+use this tool the Python "numpy" package must be installed (see the
+[measuring resonance document](Measuring_Resonances.md#software-installation)
+for more information).
+
### [bed_mesh]
The following commands are available when the