Home if not already homed.
This is useful to throw at the beginning of other macros. This is used in many of the other macros below.
[gcode_macro CG28]
gcode:
{% if "xyz" not in printer.toolhead.homed_axes %}
G28
{% endif %}
QGL if not already done.
I don't personally use this, I prefer to QGL every print. But some people like it.
[gcode_macro CQGL]
gcode:
{% if printer.quad_gantry_level.applied == False %}
QUAD_GANTRY_LEVEL
G28 Z
{% endif %}
Allows you to utilize your LCD beeper. This requires you to specify your beeper pin as an output pin.
A PWM beeper is more common nowadays, and is used on the common MINI12864 display.
Your pin may be different.
[output_pin beeper]
pin: EXP1_1
value: 0
shutdown_value: 0
pwm: True
cycle_time: 0.0005 ; Default beeper tone in kHz. 1 / 0.0005 = 2000Hz (2kHz)
Usage:
BEEP: Beep once with defaults.BEEP I=3: Beep 3 times with defaults.BEEP I=3 DUR=200 FREQ=2000: Beep 3 times, for 200ms each, at 2kHz frequency.
[gcode_macro BEEP]
gcode:
# Parameters
{% set i = params.I|default(1)|int %} ; Iterations (number of times to beep).
{% set dur = params.DUR|default(100)|int %} ; Duration/wait of each beep in ms. Default 100ms.
{% set freq = params.FREQ|default(2000)|int %} ; Frequency in Hz. Default 2kHz.
{% for iteration in range(i|int) %}
SET_PIN PIN=beeper VALUE=0.8 CYCLE_TIME={ 1.0/freq if freq > 0 else 1 }
G4 P{dur}
SET_PIN PIN=beeper VALUE=0
G4 P{dur}
{% endfor %}
This is the simple looping implementation. If you're feeling fancy, you can also play tunes with it. (Tune macros by Dustinspeed#6423)
Non-PWM beepers are used on some other displays such as the Ender 3 stock display.
Your pin will likely be different.
[output_pin beeper]
pin: P1.30
value: 0
shutdown_value: 0
Usage:
BEEP: Beep once with defaults.BEEP I=3: Beep 3 times with defaults.BEEP I=3 DUR=100: Beep 3 times, for 100ms each.
[gcode_macro BEEP]
gcode:
# Parameters
{% set i = params.I|default(1)|int %} ; Iterations (number of times to beep).
{% set dur = params.DUR|default(100)|int %} ; Duration/wait of each beep in ms. Default 100ms.
{% for iteration in range(i|int) %}
SET_PIN PIN=beeper VALUE=1
G4 P{dur}
SET_PIN PIN=beeper VALUE=0
G4 P{dur}
{% endfor %}
This just provides an easy shortcut to change your neopixel LCD color. This may need modifying depending on your particular LCD. Mine is an MINI12864.
I have my LCD turn red during runouts, and green during filament swaps.
Example usage: LCDRGB R=0.8 G=0 B=0
[gcode_macro LCDRGB]
gcode:
{% set r = params.R|default(1)|float %}
{% set g = params.G|default(1)|float %}
{% set b = params.B|default(1)|float %}
SET_LED LED=lcd RED={r} GREEN={g} BLUE={b} INDEX=1 TRANSMIT=0
SET_LED LED=lcd RED={r} GREEN={g} BLUE={b} INDEX=2 TRANSMIT=0
SET_LED LED=lcd RED={r} GREEN={g} BLUE={b} INDEX=3
To reset the RGB / set the initial RGB. (set your default LCD colors here, and use RESETRGB to call set it back.)
[gcode_macro RESETRGB]
gcode:
SET_LED LED=lcd RED=1 GREEN=0.45 BLUE=0.4 INDEX=1 TRANSMIT=0
SET_LED LED=lcd RED=0.25 GREEN=0.2 BLUE=0.15 INDEX=2 TRANSMIT=0
SET_LED LED=lcd RED=0.25 GREEN=0.2 BLUE=0.15 INDEX=3
To set the default colors at startup (required)
[delayed_gcode SETDISPLAYNEOPIXEL]
initial_duration: 1
gcode:
RESETRGB
You need [pause_resume] specified in your config to be able to use these.
Features:
-
On pause, moves the toolhead (z hops) up by 10mm, then moves the toolhead to the front for easy loading/unloading.
- Will not z hop if this exceeds your max Z height.
-
Will not allow you to accidentally execute pause or resume twice.
-
Allows you to take other actions during the pause without messing anything up.
- You can move toolhead around during the pause, run load/unload filament macros etc. It wil automatically return to its original position before resuming.
- It also automatically restores your gcode state (absolute vs relative extrusion mode, etc), should it be changed during the pause by another macro.
-
Primes the nozzle while traveling back to resume the print, wiping the excess along the way. This just results in one little string to pick off.
-
Sets the idle timeout to 12 hours during the pause, and returns it to your configured value upon resume.
-
Turns off your filament sensor during the pause, so it doesn't trip and run its runout gcode again while you're already paused.
-
Turns off the hotend during the pause, and turns it back on for the resume.*
-
* I highly advise keeping this functionality, even though it can be a bit annoying at times. It's a safety feature. It stops your hotend from cooking all night waiting for you to come and swap filament. And with a smart filament sensor, it can even sometimes catch heat creep clogs should your hotend fan fail.
-
It's probably okay to leave the hotend on during a non-runout filament change (M600) if you plan to be near your printer. If you want to do that, you can duplicate the macro to M600 (rather than just having M600 as an alias for pause) and comment that part out.
-
Some things are commented out that rely on other macros. You can uncomment them if you choose to use those other macros.
This allows your pause to work natively with slicers that insert M600 for color changes. This just calls the pause macro (below).
[gcode_macro M600]
gcode:
#LCDRGB R=0 G=1 B=0 ; Turn LCD green
PAUSE ; Pause
Connect your filament sensor to any free endstop port, and update switch_pin in the below configs accordingly. Don't forget the pullup (^) on the pin or you may get false positives.
[filament_switch_sensor filament_sensor]
switch_pin: ^P1.24
pause_on_runout: True
insert_gcode:
M117 Insert Detected
runout_gcode:
M117 Runout Detected
#LCDRGB R=1 G=0 B=0 # Turn LCD red
#BEEP I=12
Adjust detection_length to change the sensitivity. The BTT sensor "ticks" every 7mm. I recommend starting with 10mm to prevent false positives from flow dropoff, bowden slack, etc.
Note that a smart filament sensor only works when the filament is moving (or not) during extrusion. Testing with QUERY_FILAMENT_SENSOR will not work. Test by releasing filament drive tension or grabbing/cutting the filament during a print.
[filament_motion_sensor filament_sensor]
detection_length: 10
extruder: extruder
switch_pin: ^P1.24
pause_on_runout: True
insert_gcode:
M117 Insert Detected
runout_gcode:
M117 Runout Detected
#LCDRGB R=1 G=0 B=0 # Turn LCD red
#BEEP I=12
I use a BTT Smart Filament Sensor, and highly recommend it, as it can catch skipping and jams, not just runouts. It has saved a lot of prints for me, often due to partial nozzle clogs that are causing extruder skipping. Just don't forget the pullup on the pin (^)!!
If you use a filament sensor, put its name in the SET_FILAMENT_SENSOR command. Otherwise, comment that out.
If you want your toolhead to park somewhere other than front center, modify the X/Y coordinates in the last G1 command.
[gcode_macro PAUSE]
rename_existing: BASE_PAUSE
gcode:
# Parameters
{% set z = params.Z|default(10)|int %} ; z hop amount
{% if printer['pause_resume'].is_paused|int == 0 %}
SET_GCODE_VARIABLE MACRO=RESUME VARIABLE=zhop VALUE={z} ; set z hop variable for reference in resume macro
SET_GCODE_VARIABLE MACRO=RESUME VARIABLE=etemp VALUE={printer['extruder'].target} ; set hotend temp variable for reference in resume macro
SET_FILAMENT_SENSOR SENSOR=filament_sensor ENABLE=0 ; disable filament sensor
SAVE_GCODE_STATE NAME=PAUSE ; save current print position for resume
BASE_PAUSE ; pause print
{% if (printer.gcode_move.position.z + z) < printer.toolhead.axis_maximum.z %} ; check that zhop doesn't exceed z max
G91 ; relative positioning
G1 Z{z} F900 ; raise Z up by z hop amount
{% else %}
{ action_respond_info("Pause zhop exceeds maximum Z height.") } ; if z max is exceeded, show message and set zhop value for resume to 0
SET_GCODE_VARIABLE MACRO=RESUME VARIABLE=zhop VALUE=0
{% endif %}
G90 ; absolute positioning
G1 X{printer.toolhead.axis_maximum.x/2} Y{printer.toolhead.axis_minimum.y+5} F6000 ; park toolhead at front center
SAVE_GCODE_STATE NAME=PAUSEPARK ; save parked position in case toolhead is moved during the pause (otherwise the return zhop can error)
M104 S0 ; turn off hotend
SET_IDLE_TIMEOUT TIMEOUT=43200 ; set timeout to 12 hours
{% endif %}
If you use a filament sensor, put its name in the SET_FILAMENT_SENSOR command. Otherwise, comment that out.
[gcode_macro RESUME]
rename_existing: BASE_RESUME
variable_zhop: 0
variable_etemp: 0
gcode:
# Parameters
{% set e = params.E|default(2.5)|int %} ; hotend prime amount (in mm)
{% if printer['pause_resume'].is_paused|int == 1 %}
SET_FILAMENT_SENSOR SENSOR=filament_sensor ENABLE=1 ; enable filament sensor
#RESETRGB ; reset LCD color
SET_IDLE_TIMEOUT TIMEOUT={printer.configfile.settings.idle_timeout.timeout} ; set timeout back to configured value
{% if etemp > 0 %}
M109 S{etemp|int} ; wait for hotend to heat back up
{% endif %}
RESTORE_GCODE_STATE NAME=PAUSEPARK MOVE=1 MOVE_SPEED=100 ; go back to parked position in case toolhead was moved during pause (otherwise the return zhop can error)
G91 ; relative positioning
M83 ; relative extruder positioning
{% if printer[printer.toolhead.extruder].temperature >= printer.configfile.settings.extruder.min_extrude_temp %}
G1 Z{zhop * -1} E{e} F900 ; prime nozzle by E, lower Z back down
{% else %}
G1 Z{zhop * -1} F900 ; lower Z back down without priming (just in case we are testing the macro with cold hotend)
{% endif %}
RESTORE_GCODE_STATE NAME=PAUSE MOVE=1 MOVE_SPEED=60 ; restore position
BASE_RESUME ; resume print
{% endif %}
Clears any pause and runs PRINT_END macro.
[gcode_macro CANCEL_PRINT]
rename_existing: BASE_CANCEL_PRINT
gcode:
SET_IDLE_TIMEOUT TIMEOUT={printer.configfile.settings.idle_timeout.timeout} ; set timeout back to configured value
CLEAR_PAUSE
SDCARD_RESET_FILE
PRINT_END
BASE_CANCEL_PRINT
If you use Octoprint, put these in your "GCODE Script" section to enable the UI buttons to work properly.
This disables the filament sensor 1 second after startup. This prevents it from tripping constantly while you're just loading filament, doing testing or maintenance, etc.
Put your filament sensor's name after SENSOR=.
[delayed_gcode DISABLEFILAMENTSENSOR]
initial_duration: 1
gcode:
SET_FILAMENT_SENSOR SENSOR=filament_sensor ENABLE=0
Then:
- Put
SET_FILAMENT_SENSOR SENSOR=filament_sensor ENABLE=1in yourPRINT_START/resume macros. - Put
SET_FILAMENT_SENSOR SENSOR=filament_sensor ENABLE=0in yourPRINT_END/pause/cancel macros.
The above pause/resume/cancel macros have this already. Just update the sensor name.
Park the toolhead at different places. Automatically determined based on your printer's configured size.
# Park front center
[gcode_macro PARKFRONT]
gcode:
CG28 ; home if not already homed
SAVE_GCODE_STATE NAME=PARKFRONT
G90 ; absolute positioning
G0 X{printer.toolhead.axis_maximum.x/2} Y{printer.toolhead.axis_minimum.y+5} Z{printer.toolhead.axis_maximum.z/2} F6000
RESTORE_GCODE_STATE NAME=PARKFRONT
# Park front center, but low down.
[gcode_macro PARKFRONTLOW]
gcode:
CG28 ; home if not already homed
SAVE_GCODE_STATE NAME=PARKFRONT
G90 ; absolute positioning
G0 X{printer.toolhead.axis_maximum.x/2} Y{printer.toolhead.axis_minimum.y+5} Z20 F6000
RESTORE_GCODE_STATE NAME=PARKFRONT
# Park top rear left
[gcode_macro PARKREAR]
gcode:
CG28 ; home if not already homed
SAVE_GCODE_STATE NAME=PARKREAR
G90 ; absolute positioning
G0 X{printer.toolhead.axis_minimum.x+10} Y{printer.toolhead.axis_maximum.y-10} Z{printer.toolhead.axis_maximum.z-50} F6000
RESTORE_GCODE_STATE NAME=PARKREAR
# Park at center of build volume
[gcode_macro PARKCENTER]
gcode:
CG28 ; home if not already homed
SAVE_GCODE_STATE NAME=PARKCENTER
G90 ; absolute positioning
G0 X{printer.toolhead.axis_maximum.x/2} Y{printer.toolhead.axis_maximum.y/2} Z{printer.toolhead.axis_maximum.z/2} F6000
RESTORE_GCODE_STATE NAME=PARKCENTER
# Park 15mm above center of bed
[gcode_macro PARKBED]
gcode:
CG28 ; home if not already homed
SAVE_GCODE_STATE NAME=PARKBED
G90 ; absolute positioning
G0 X{printer.toolhead.axis_maximum.x/2} Y{printer.toolhead.axis_maximum.y/2} Z15 F6000
RESTORE_GCODE_STATE NAME=PARKBED
Just an idea more than a copy-pastable macro as yours will be different.
It's just handy to have a shortcut to turn off everything at once!
[gcode_macro OFF]
gcode:
M84 ; turn steppers off
TURN_OFF_HEATERS ; turn bed / hotend off
M107 ; turn print cooling fan off
#SET_FAN_SPEED FAN=Exhaust SPEED=0 ; turn exhaust fan off
#SET_FAN_SPEED FAN=BedFans SPEED=0 ; bed fan off
#SET_PIN PIN=caselight VALUE=0 ; turn case light off
OctoPrint and Moonraker use different shutdown commands, but it doesn't hurt to have both.
I also throw in commands to turn off everything else first, otherwise your case lighting / neopixels etc will stay on.
[gcode_macro SHUTDOWN]
gcode:
#LCDRGB R=0 G=0 B=0 ; Turn off LCD neopixels (see above for this macro)
#OFF ; Shortcut to turn everything off (see above for this macro)
{action_respond_info('action:poweroff')} ; OctoPrint compatible host shutdown
{action_call_remote_method("shutdown_machine")} ; Moonraker compatible host shutdown
Then you can add it to the "setup" menu of your LCD with this:
[menu __main __setup __shutdown]
type: command
enable: {not printer.idle_timeout.state == "Printing"}
name: Shut down
gcode: SHUTDOWN
Or the "control" menu, if you prefer, with this:
[menu __main __control __shutdown]
type: command
enable: {not printer.idle_timeout.state == "Printing"}
name: Shut down
gcode: SHUTDOWN
This dumps all current Klipper variables to the g-code terminal.
This helps to find Klipper system variables for use in macros. A filter for both name and value can be applied.
[gcode_macro DUMP_VARIABLES]
gcode:
{% set filter_name = params.NAME|default('')|string|lower %}
{% set filter_value = params.VALUE|default('')|string|lower %}
{% set show_cfg = params.SHOW_CFG|default(0)|int %}
{% set out = [] %}
{% for key1 in printer %}
{% for key2 in printer[key1] %}
{% if (show_cfg or not (key1|lower == 'configfile' and key2|lower in ['config', 'settings'])) and (filter_name in key1|lower or filter_name in key2|lower) and filter_value in printer[key1][key2]|string|lower %}
{% set dummy = out.append("printer['%s'].%s = %s" % (key1, key2, printer[key1][key2])) %}
{% endif %}
{% else %}
{% if filter_name in key1|lower and filter_value in printer[key1]|string|lower %}
{% set dummy = out.append("printer['%s'] = %s" % (key1, printer[key1])) %}
{% endif %}
{% endfor %}
{% endfor %}
{action_respond_info(out|join("\n"))}
The filtering functionality was contributed by FatalBulletHit. Thanks!
NAME(string) - Filter results based on name (only show varables with names containing this string)VALUE(string) - Filter results based on value (only show values containing this value)SHOW_CFG(integer, 0-1) - Set to 1 to include entire config in output. Default 0 (config filtered out)
DUMP_VARIABLES: Returns all variables (excludingprinter['configfile'].configandprinter['configfile'].settingsas they contain the entire config).DUMP_VARIABLES NAME=stepper: Returns all variables which have the stringstepperin their name.DUMP_VARIABLES VALUE=extruder: Returns all variables which have the stringextruderin their value.DUMP_VARIABLES NAME=stepper VALUE=extruder: Returns all variables which have the stringstepperin their name and the stringextruderin their value.DUMP_VARIABLES SHOW_CFG=1: Returns all variables, including the config.
Contributed by FatalBulletHit. Thanks!
This returns value and type of a single variable to the g-code terminal. Keys and indexes can be chained to access nested dictionaries and lists.
[gcode_macro GET_VARIABLE]
gcode:
{% set names = (params.NAME).split('.')|list %}
{% set join = (params.JOIN)|default(1)|int %}
{% set _dummy0 = namespace( break = 0 ) %}
{% set _dummy1 = namespace( out = printer[names|first] ) %}
{% for name in names if _dummy0.break == 0 %}
{% if loop.index > 1 %}
{% if name in _dummy1.out %}
{% set _dummy1.out = _dummy1.out[name] %}
{% elif name[0] in '0123456789' and _dummy1.out is iterable and _dummy1.out is not string and _dummy1.out is not mapping and _dummy1.out|length > name[0]|int %}
{% set _dummy1.out = _dummy1.out[name|int] %}
{% else %}
{% set _dummy0.break = loop.index0 %}
{% endif %}
{% endif %}
{% endfor %}
{% if _dummy1.out is boolean %}
{ action_respond_info('Type: boolean') }
{% elif _dummy1.out is float %}
{ action_respond_info('Type: float') }
{% elif _dummy1.out is integer %}
{ action_respond_info('Type: integer') }
{% elif _dummy1.out is mapping %}
{ action_respond_info('Type: mapping') }
{% elif _dummy1.out is string %}
{ action_respond_info('Type: string') }
{% elif _dummy1.out is iterable %}
{ action_respond_info('Type: iterable') }
{% elif _dummy1.out is none %}
{ action_respond_info('Type: none') }
{% elif _dummy1.out is undefined %}
{ action_respond_info('Type: undefined') }
{% elif _dummy1.out is callable %}
{ action_respond_info('Type: callable') }
{% else %}
{ action_respond_info('Type: unknown') }
{% endif %}
{% if join and _dummy1.out is iterable and _dummy1.out is not string and _dummy1.out is not mapping %}
{ action_respond_info('%s' % _dummy1.out|join("\n")) }
{% else %}
{ action_respond_info('%s' % _dummy1.out) }
{% endif %}
{% if _dummy0.break != 0 %}
{ action_respond_info('"printer.%s" does not contain "%s"!' % (names[0:_dummy0.break]|join('.'), names[_dummy0.break])) }
{% endif %}
NAME(string) (required) - Specify the name of the variable that you want to retreive.
GET_VARIABLE NAME=toolhead: Returns value and type of variableprinter.toolhead.GET_VARIABLE NAME=bed_mesh.profiles.default.points.1.0: Returns value and type of variableprinter.bed_mesh.profiles.default.points[1][0].
Replace M109 (wait for hotend temperature) and M190 (wait for bed temperature) with TEMPERATURE_WAIT.
This just makes Klipper resume immediately after reaching temp. Otherwise it waits for the temperature to stabilize.
[gcode_macro M109]
rename_existing: M99109
gcode:
#Parameters
{% set s = params.S|float %}
M104 {% for p in params %}{'%s%s' % (p, params[p])}{% endfor %} ; Set hotend temp
{% if s != 0 %}
TEMPERATURE_WAIT SENSOR=extruder MINIMUM={s} MAXIMUM={s+1} ; Wait for hotend temp (within 1 degree)
{% endif %}
[gcode_macro M190]
rename_existing: M99190
gcode:
#Parameters
{% set s = params.S|float %}
M140 {% for p in params %}{'%s%s' % (p, params[p])}{% endfor %} ; Set bed temp
{% if s != 0 %}
TEMPERATURE_WAIT SENSOR=heater_bed MINIMUM={s} MAXIMUM={s+1} ; Wait for bed temp (within 1 degree)
{% endif %}