diff options
| author | Alex Zellner <37265689+zellneralex@users.noreply.github.com> | 2021-05-26 20:21:21 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-26 14:21:21 -0400 |
| commit | 341fc64a670e96f5be5e63abe41cc51cb90ed898 (patch) | |
| tree | 5211a4d841c66510321f7c0f9c32588036694078 /docs/Command_Templates.md | |
| parent | ba3bbca8618e3ba2cea961c72474d5a89974b23d (diff) | |
| download | kutter-341fc64a670e96f5be5e63abe41cc51cb90ed898.tar.gz kutter-341fc64a670e96f5be5e63abe41cc51cb90ed898.tar.xz kutter-341fc64a670e96f5be5e63abe41cc51cb90ed898.zip | |
gcode_macro: add description property (#4317)
Signed-off-by: Alex Zellner <alexander.zellner@googlemail.com>
Diffstat (limited to 'docs/Command_Templates.md')
| -rw-r--r-- | docs/Command_Templates.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/Command_Templates.md b/docs/Command_Templates.md index a5e3d323..f27f4a65 100644 --- a/docs/Command_Templates.md +++ b/docs/Command_Templates.md @@ -27,6 +27,25 @@ Note how the `gcode:` config option always starts at the beginning of the line and subsequent lines in the G-Code macro never start at the beginning. +### Add a description to your macro + +To help identify the functionality a short description can be added. +Add `description:` with a short text to describe the functionality. +Default is "G-Code macro" if not specified. +For example: + +``` +[gcode_macro blink_led] +description: Blink my_led one time +gcode: + SET_PIN PIN=my_led VALUE=1 + G4 P2000 + SET_PIN PIN=my_led VALUE=0 +``` + +This will be showing is you use the `HELP` command or use the autocomplete +function. + ### Save/Restore state for G-Code moves Unfortunately, the G-Code command language can be challenging to use. |