3D-printing/klipper
1
0
Fork 0
mirror of https://github.com/Klipper3d/klipper.git synced 2025-08-06 21:44:13 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

gcode_macro: add description property (#4317)

Browse source 
Signed-off-by: Alex Zellner <alexander.zellner@googlemail.com>
This commit is contained in:
Alex Zellner 2021-05-26 20:21:21 +02:00 • committed by GitHub
parent ba3bbca861
commit 341fc64a67
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 23 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/Command_Templates.md
View file

@ -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.

3
docs/Config_Reference.md
View file

@ -1237,6 +1237,9 @@ G-Code macros (one may define any number of sections with a
# commands. Care should be taken when overriding commands as it can
# cause complex and unexpected results. The default is to not
# override an existing G-Code command.
#description: G-Code macro
# This will add a short description used at the HELP command or while
# using the auto completion feature. Default "G-Code macro"
```
## [delayed_gcode]