Skip to content

GrumpyScreen Macros

The Macros tab provides one-touch buttons for Klipper G-code macros. It is available from the Console screen when Klipper is connected. Selecting a button sends its macro command and returns to the Console tab so that its response is visible.

Add a macro

Edit the GrumpyScreen configuration file and add one section for each button:

[macro "BED_MESH_CALIBRATE"]
display_name: Bed Mesh
icon: bed

The value in the section header is the G-code command sent to Klipper. display_name is optional; when omitted, the command itself is shown. icon is optional and defaults to refresh.

For example, a macro with parameters can be added exactly as it would be entered in the Console:

[macro "G28 X Y"]
display_name: Home XY
icon: home

Restart GrumpyScreen after saving the configuration. Macros can also be placed in the GrumpyScreen override configuration; this is useful for machine-specific buttons.

Icon reference

Use the value in the first column as icon: <value>. If an unknown value is supplied, GrumpyScreen uses the refresh icon.

Icon value Preview Meaning
arrow_down Down arrow Down arrow
arrow_left Left arrow Left arrow
arrow_right Right arrow Right arrow
arrow_up Up arrow Up arrow
back Back Back or return
bed Bed Heated bed or bed mesh
cancel Cancel Cancel or stop current action
clock Clock Time or timer
cooldown Cooldown Cool down heaters
delete Delete Delete or clear
emergency Emergency Emergency stop
extrude Extrude Extrude filament
extruder Extruder Extruder or hotend
factory_reset Factory reset Factory reset
fan Fan Fan control
fan_off Fan off Turn a fan off
fan_on Fan on Turn a fan on
fine_tune Fine tune Fine tuning
firmware Firmware Firmware action
flow Flow Flow adjustment
flow_up Flow up Increase flow
gui GUI Screen or GUI action
heater Heater Heater control
home Home Home printer axes
home_z Home Z Home Z axis
hourglass Hourglass Waiting or in progress
infinity Infinity Continuous or unlimited action
info Information Information
layers Layers Print layers
light Light Turn a light on
light_off Light off Turn a light off
load_filament Load filament Load filament
motor_off Motor off Disable motors
move Move Move printer axes
pa_plus Pressure advance Increase pressure advance
pause Pause Pause a print
print Print Print action
refresh Refresh Refresh or rerun
restart Restart Restart
resume Resume Resume a print
retract Retract Retract filament
sd SD card SD card or files
shutdown Shutdown Shut down host
speed_up Speed up Increase speed
spoolman Spoolman Spoolman or spool management
support_zip Support zip Create a support archive
switch_stock Switch to stock Switch to stock firmware
unload_filament Unload filament Unload filament
update Update Update software or firmware
z_closer Z closer Move Z closer to the bed
z_farther Z farther Move Z farther from the bed