aboutsummaryrefslogtreecommitdiffstats
path: root/docs/G-Codes.md
diff options
context:
space:
mode:
authorDmitry Butyugin <dmbutyugin@google.com>2021-06-27 17:40:14 +0200
committerKevinOConnor <kevin@koconnor.net>2021-07-08 11:00:23 -0400
commit2ef5e03ce4dd132d56a811885eda5681f358106d (patch)
treeef35c8398f19da096e4b5705dfa0f1b167be7d22 /docs/G-Codes.md
parent1128e9179b82446559f2768e46ba87b13000a78a (diff)
downloadkutter-2ef5e03ce4dd132d56a811885eda5681f358106d.tar.gz
kutter-2ef5e03ce4dd132d56a811885eda5681f358106d.tar.xz
kutter-2ef5e03ce4dd132d56a811885eda5681f358106d.zip
docs: Updated docs for custom AXIS in TEST_RESONANCES
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
Diffstat (limited to 'docs/G-Codes.md')
-rw-r--r--docs/G-Codes.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 026b93ec..37e363f4 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -755,9 +755,13 @@ is enabled (also see the
- `TEST_RESONANCES AXIS=<axis> OUTPUT=<resonances,raw_data>
[NAME=<name>] [FREQ_START=<min_freq>] [FREQ_END=<max_freq>]
[HZ_PER_SEC=<hz_per_sec>] [INPUT_SHAPING=[<0:1>]]`: Runs the resonance
- test in all configured probe points for the requested axis (X or Y)
+ test in all configured probe points for the requested <axis>
and measures the acceleration using the accelerometer chips configured
- for the respective axis. If `INPUT_SHAPING=0` or not set (default),
+ for the respective axis. <axis> can either be X or Y, or specify an
+ arbitrary direction as `AXIS=dx,dy`, where dx and dy are floating point
+ numbers defining a direction vector (e.g. `AXIS=X`, `AXIS=Y`, or
+ `AXIS=1,-1` to define a diagonal direction). Note that `AXIS=dx,dy` and
+ `AXIS=-dx,-dy` is equivalent. If `INPUT_SHAPING=0` or not set (default),
disables input shaping for the resonance testing, because it is not valid
to run the resonance testing with the input shaper enabled.
`OUTPUT` parameter is a comma-separated list of which outputs will be