diff options
| author | David Smith <davidosmith@gmail.com> | 2020-01-06 10:59:40 -0500 |
|---|---|---|
| committer | KevinOConnor <kevin@koconnor.net> | 2020-01-06 10:59:40 -0500 |
| commit | 6972b6303dd735a85558012c14b07e76076894e9 (patch) | |
| tree | 02ad36048229cc218ad66446a61e9a91002fcbb2 /docs/Command_Templates.md | |
| parent | baa0d2ff8c9e00596cad695a5bfe7157dfd2e9a8 (diff) | |
| download | kutter-6972b6303dd735a85558012c14b07e76076894e9.tar.gz kutter-6972b6303dd735a85558012c14b07e76076894e9.tar.xz kutter-6972b6303dd735a85558012c14b07e76076894e9.zip | |
docs: Updates for gcode_macro naming (#2317)
Add note about numbers in macro names. Add note about variable name case restriction. Add set variable example.
Signed-off-by: David O Smith <davidosmith@gmail.com>
Diffstat (limited to 'docs/Command_Templates.md')
| -rw-r--r-- | docs/Command_Templates.md | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/Command_Templates.md b/docs/Command_Templates.md index 383c4694..e45fdf0e 100644 --- a/docs/Command_Templates.md +++ b/docs/Command_Templates.md @@ -1,6 +1,12 @@ This document provides information on implementing G-Code command sequences in gcode_macro (and similar) config sections. +### G-Code Macro Naming +Case is not important when creating a G-Code macro name. MY_MACRO and +my_macro will evaluate the same and may be called in either upper or +lower case. If any numerical digits are used in the macro name they +must all be placed at the end of the name. + ### Formatting of G-Code in the config Indentation is important when defining a macro in the config file. To @@ -178,7 +184,8 @@ in future Klipper releases. ### Variables The SET_GCODE_VARIABLE command may be useful for saving state between -macro calls. For example: +macro calls. Variable names may not contain any upper case characters. +For example: ``` [gcode_macro start_probe] |