CreatBot/CreatBotKlipper
6
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Updates for gcode_macro naming (#2317)

Browse Source 
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>
This commit is contained in:
David Smith
2020-01-06 10:59:40 -05:00
committed by KevinOConnor
parent baa0d2ff8c
commit 6972b6303d
2 changed files with 18 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
config/example-extras.cfg
View File

@@ -389,7 +389,9 @@
######################################################################
# G-Code macros (one may define any number of sections with a
# "gcode_macro" prefix).
# "gcode_macro" prefix). If G-Code macro names contain any numbers
# they must all be at the end of the macro's name.
# (example: test_macro25 is acceptable, but macro25_test3 is not).
#[gcode_macro my_cmd]
#gcode:
# A list of G-Code commands to execute in place of "my_cmd". See
@@ -409,9 +411,13 @@
# One may specify any number of options with a "variable_" prefix.
# The given variable name will be assigned the given value (parsed
# as a Python literal) and will be available during macro expansion.
# For example, a config with "variable_fan_speed = 75" might have
# gcode commands containing "M106 S{ fan_speed * 255 }". Variables
# can be changed at run-time using the SET_GCODE_VARIABLE command.
# For example, a macro called set_fan with
# "variable_fan_speed = 75" might have gcode commands containing
# "M106 S{ fan_speed * 255 }". Variables can be changed at run-time
# using the SET_GCODE_VARIABLE command from within any G-Code Macro.
# Example, from a macro called my_macro2 I could state:
# "SET_GCODE_VARIABLE MACRO=set_fan VARIABLE=fan_speed VALUE=50"
# Variable names may not use upper case characters.
# Execute a gcode on a set delay.
#[delayed_gcode my_delayed_gcode]