3diy
/
klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

gcode_macro: Deprecate default_parameter_<name> 

The Jinja2 "set" directive is more flexible and easier to understand
than default_parameter_XXX parameters.  Deprecate it and encourage
using "set" as a replacement.

This also deprecates direct access to parameters via parameter name in
a macro.  Going forward, the `params` pseudo-variable must be used to
access a parameter.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2021-04-26 12:46:22 -04:00
parent dd28c7aef7
commit f10247a498
2 changed files with 6 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Config_Changes.md
View File

@ -6,6 +6,12 @@ All dates in this document are approximate.
# Changes # Changes
20210503: The gcode_macro `default_parameter_<name>` config option is
deprecated. Use the `params` pseudo-variable to access macro
parameters. Other methods for accessing macro parameters will be
removed in the near future. See the [Command Templates
document](Command_Templates.md#macro-parameters) for examples.
20210430: The SET_VELOCITY_LIMIT (and M204) command may now set a 20210430: The SET_VELOCITY_LIMIT (and M204) command may now set a
velocity, acceleration, and square_corner_velocity larger than the velocity, acceleration, and square_corner_velocity larger than the
specified values in the config file. specified values in the config file.

10
docs/Config_Reference.md
View File

@ -1155,16 +1155,6 @@ G-Code macros (one may define any number of sections with a
# A list of G-Code commands to execute in place of "my_cmd". See # A list of G-Code commands to execute in place of "my_cmd". See
# docs/Command_Templates.md for G-Code format. This parameter must # docs/Command_Templates.md for G-Code format. This parameter must
# be provided. # be provided.
#default_parameter_<parameter>:
# One may define any number of options with a "default_parameter_"
# prefix. Use this to define default values for g-code parameters.
# For example, if one were to define the macro MY_DELAY with gcode
# "G4 P{DELAY}" along with "default_parameter_DELAY = 50" then the
# command "MY_DELAY" would evaluate to "G4 P50". To override the
# default parameter when calling the command then using
# "MY_DELAY DELAY=30" would evaluate to "G4 P30". The default is
# to require that all parameters used in the gcode script be
# present in the command invoking the macro.
#variable_<name>: #variable_<name>:
# One may specify any number of options with a "variable_" prefix. # One may specify any number of options with a "variable_" prefix.
# The given variable name will be assigned the given value (parsed # The given variable name will be assigned the given value (parsed