aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorgithub@matthewlloyd.net <github@matthewlloyd.net>2021-08-31 20:06:13 -0400
committerKevinOConnor <kevin@koconnor.net>2021-09-02 12:05:31 -0400
commit830c80a88a3def5e2a4ef0ff9a6d833eff475d5e (patch)
tree07e61dca5f31e7d2c96a718e4803c219e2c685aa /docs
parent286cc1beccea7d9d7c6ddf317874f2ccac9d7c51 (diff)
downloadkutter-830c80a88a3def5e2a4ef0ff9a6d833eff475d5e.tar.gz
kutter-830c80a88a3def5e2a4ef0ff9a6d833eff475d5e.tar.xz
kutter-830c80a88a3def5e2a4ef0ff9a6d833eff475d5e.zip
tuning_tower: Add STEP_DELTA and STEP_HEIGHT parameters as alternate tuning tower syntax
Signed-off-by: Matthew Lloyd <github@matthewlloyd.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/G-Codes.md39
1 files changed, 27 insertions, 12 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 70e3abe2..4d40956f 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -212,18 +212,33 @@ The following standard commands are supported:
babystepping), and subtract it from the stepper_z endstop_position.
This acts to take a frequently used babystepping value, and "make
it permanent". Requires a `SAVE_CONFIG` to take effect.
-- `TUNING_TOWER COMMAND=<command> PARAMETER=<name> START=<value>
- FACTOR=<value> [BAND=<value>] [SKIP=<value>]`: A tool for tuning
- a parameter on each Z height during a print. The tool will run
- the given COMMAND with the given PARAMETER assigned to the value
- using the formula `value = start + factor * z_height`. If BAND is
- provided then the adjustment will only be made every BAND
- millimeters of z height - in that case the formula used is
- `value = start + factor * ((floor(z_height / band) + .5) * band)`.
- If `SKIP=<value>` is specified, the tuning process doesn't begin
- until Z height `<value>` is reached, and below that the value will
- be set to `START`; in this case, the `z_height` used in the
- formulas above is actually `max(z - skip, 0)`.
+- `TUNING_TOWER COMMAND=<command> PARAMETER=<name> START=<value> [SKIP=<value>]
+ [FACTOR=<value> [BAND=<value>]] | [STEP_DELTA=<value> STEP_HEIGHT=<value>]`:
+ A tool for tuning a parameter on each Z height during a print.
+ The tool will run the given `COMMAND` with the given `PARAMETER`
+ assigned to a value that varies with `Z` according to a formula. Use `FACTOR`
+ if you will use a ruler or calipers to measure the Z height of the optimum
+ value, or `STEP_DELTA` and `STEP_HEIGHT` if the tuning tower model has bands
+ of discrete values as is common with temperature towers. If `SKIP=<value>`
+ is specified, the tuning process doesn't begin until Z height `<value>` is
+ reached, and below that the value will be set to `START`; in this case, the
+ `z_height` used in the formulas below is actually `max(z - skip, 0)`.
+ There are three possible combinations of options:
+ - `FACTOR`: The value changes at a rate of `factor` per millimeter.
+ The formula used is
+ `value = start + factor * z_height`.
+ You can plug the optimum Z height directly into the formula to
+ determine the optimum parameter value.
+ - `FACTOR` and `BAND`: The value changes at an average rate of `factor` per
+ millimeter, but in discrete bands where the adjustment will only be made
+ every `BAND` millimeters of Z height.
+ The formula used is
+ `value = start + factor * ((floor(z_height / band) + .5) * band)`.
+ - `STEP_DELTA` and `STEP_HEIGHT`: The value changes by `STEP_DELTA` every
+ `STEP_HEIGHT` millimeters. The formula used is
+ `value = start + step_delta * floor(z_height / step_height)`.
+ You can simply count bands or read tuning tower labels to determine the
+ optimum value.
- `SET_DISPLAY_GROUP [DISPLAY=<display>] GROUP=<group>`: Set the
active display group of an lcd display. This allows to define
multiple display data groups in the config,