aboutsummaryrefslogtreecommitdiffstats
path: root/docs/G-Codes.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2020-11-16 18:47:32 -0500
committerKevin O'Connor <kevin@koconnor.net>2020-11-18 20:10:21 -0500
commit15b5dbaf8ffac8e3889b2cc0ba7a61bce1e9fb6f (patch)
treefbb9fb7be4266684eb67f0b7d36379b523f8a240 /docs/G-Codes.md
parent9fd8f7761e424807c9f69165430e562bb2ab0390 (diff)
downloadkutter-15b5dbaf8ffac8e3889b2cc0ba7a61bce1e9fb6f.tar.gz
kutter-15b5dbaf8ffac8e3889b2cc0ba7a61bce1e9fb6f.tar.xz
kutter-15b5dbaf8ffac8e3889b2cc0ba7a61bce1e9fb6f.zip
docs: Move config reference information to new Config_Reference.md
Move all the config reference information from files in the config/ directory to a new Config_Reference.md document. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/G-Codes.md')
-rw-r--r--docs/G-Codes.md28
1 files changed, 14 insertions, 14 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 43a3ae85..31ada1c3 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -44,9 +44,9 @@ possible G-Code command. Instead, Klipper prefers human readable
If one requires a less common G-Code command then it may be possible
to implement it with a custom Klipper gcode_macro (see
-[example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
-for details). For example, one might use this to implement: `G12`,
-`G29`, `G30`, `G31`, `M42`, `M80`, `M81`, `T1`, etc.
+[config reference](Config_Reference.md#gcode_macro) for details). For
+example, one might use this to implement: `G12`, `G29`, `G30`, `G31`,
+`M42`, `M80`, `M81`, `T1`, etc.
## G-Code SD card commands
@@ -320,9 +320,7 @@ enabled:
[SAMPLES_RESULT=median|average]`: Move the nozzle downwards until
the probe triggers. If any of the optional parameters are provided
they override their equivalent setting in the probe config section
- (see
- [example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
- for details).
+ (see [config reference](Config_Reference.md#probe) for details).
- `QUERY_PROBE`: Report the current status of the probe ("triggered"
or "open").
- `PROBE_ACCURACY [PROBE_SPEED=<mm/s>] [SAMPLES=<count>]
@@ -622,15 +620,17 @@ been enabled:
The following command is enabled if an [input_shaper] config section has
been enabled:
- `SET_INPUT_SHAPER [SHAPER_FREQ_X=<shaper_freq_x>]
- [SHAPER_FREQ_Y=<shaper_freq_y>] [DAMPING_RATIO_X=<damping_ratio_x>]
+ [SHAPER_FREQ_Y=<shaper_freq_y>]
+ [DAMPING_RATIO_X=<damping_ratio_x>]
[DAMPING_RATIO_Y=<damping_ratio_y>] [SHAPER_TYPE=<shaper>]
- [SHAPER_TYPE_X=<shaper_type_x>] [SHAPER_TYPE_Y=<shaper_type_y>]`: Modify
- input shaper parameters. Note that SHAPER_TYPE parameter resets input shaper
- for both X and Y axes even if different shaper types have been configured
- in [input_shaper] section. SHAPER_TYPE cannot be used together with either
- of SHAPER_TYPE_X and SHAPER_TYPE_Y parameters. See
- [example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
- for more details on each of these parameters.
+ [SHAPER_TYPE_X=<shaper_type_x>] [SHAPER_TYPE_Y=<shaper_type_y>]`:
+ Modify input shaper parameters. Note that SHAPER_TYPE parameter
+ resets input shaper for both X and Y axes even if different shaper
+ types have been configured in [input_shaper] section. SHAPER_TYPE
+ cannot be used together with either of SHAPER_TYPE_X and
+ SHAPER_TYPE_Y parameters. See
+ [config reference](Config_Reference.md#input_shaper) for more
+ details on each of these parameters.
## Temperature Fan Commands