Skip to content

Main

A macro is a small program written in Klipper/Gcode language.

It can be called from:

  • A GCODE file
  • The Fluidd/Mainsail console (press the English letter C in Fluidd)

Note

The value in parentheses is the default value

START_PRINT

Replaces the default start G-code. For printers with a native screen, add M140/M190 S[bed_temp] and M109/M104 S[nozzle_temp].

Parameters:

  • EXTRUDER_TEMP — extruder temperature (default: 245)
  • BED_TEMP — bed temperature (default: 80)
  • MESH — bed mesh profile name (empty = no mesh loaded/created)
  • FORCE_LEVELING — force bed leveling (default: False)
  • SKIP_LEVELING — skip bed leveling entirely (overrides FORCE_KAMP/FORCE_LEVELING, default: False)

  • FORCE_KAMP — build an adaptive bed mesh (KAMP, default: False). Recommended to add SAVE_ZMOD_DATA CLEAR=LINE_PURGE to use purge areas for KAMP.

  • Z_OFFSET — set Z offset (default: 0.0)

  • INTERNAL - For the PRO version when operating without the native screen, 1 - enable internal recirculation (0)
  • EXTERNAL - For the PRO version when operating without the native screen, 1 - enable external recirculation (0)

Notes:

  • Any calibration (e.g., FORCE_KAMP/FORCE_LEVELING) triggers CLEAR_NOZZLE.
  • [ZSSH_RELOAD](/Zmod/#zssh_reload) is called during START_PRINT to restore SSH if needed.

Example for Orca with native screen: Replace the start G-code with: 

START_PRINT EXTRUDER_TEMP=[nozzle_temperature_initial_layer] BED_TEMP=[bed_temperature_initial_layer_single]
M190 S[bed_temperature_initial_layer_single]
M104 S[nozzle_temperature_initial_layer]

Example for Orca without native screen: 

START_PRINT EXTRUDER_TEMP=[nozzle_temperature_initial_layer] BED_TEMP=[bed_temperature_initial_layer_single]

Layer tracking in Fluidd: Add to start G-code: 

SET_PRINT_STATS_INFO TOTAL_LAYER=[total_layer_count]
Add to layer change G-code: 
SET_PRINT_STATS_INFO CURRENT_LAYER={layer_num + 1}

Bed leveling options

Global flags (set via SAVE_ZMOD_DATA):

  • PRECLEAR — pre-nozzle cleaning in CLEAR_NOZZLE: 0 = disable, 1 = enable (default: 0).
  • CLEAR — nozzle cleaning method (LINE_PURGE).
  • PRINT_LEVELING — enable bed leveling for every print: 0 = disable, 1 = enable (default: 0).
  • USE_KAMP — use adaptive bed mesh (KAMP) where possible: 0 = disable, 1 = enable (default: 0).
  • DISABLE_PRIMING — disable nozzle priming: 0 = enable, 1 = disable (default: 0).

  • FORCE_MD5 — verify file MD5 hashes (default: 1). Use addMD5.bat or addMD5.sh in post-processing scripts.

  • DISABLE_SKEW — disable skew correction: 1 = disable, 0 = load skew_profile (default: 1).

  • AUTO_REBOOT — auto-reboot after print: 0 = disable, 1 = enable, 2 = firmware restart (default: 0).
  • CLOSE_DIALOGS — auto-close dialogs: 0 = disable, 1 = slow, 2 = fast (requires enabling "Local Network Only" on the printer screen).
  • STOP_MOTOR — disable motors after print: 0 = disable, 1 = enable (default: 1).
  • MIDI_START — MIDI file to play on print start (e.g., "start.mid").
  • MIDI_END — MIDI file to play on print end.

Bed leveling logic:

  1. Load mesh from MESH if specified.
  2. Skip leveling if SKIP_LEVELING = True.
  3. Build KAMP mesh if FORCE_KAMP = True.
  4. Build full mesh if no mesh is loaded or FORCE_LEVELING = True.

END_PRINT

Replaces the default end G-code.

Global flags (set via SAVE_ZMOD_DATA):

  • AUTO_REBOOT — auto-reboot after print (same as above).
  • CLOSE_DIALOGS — auto-close dialogs (same as above).
  • STOP_MOTOR — disable motors after print (same as above).
  • MIDI_END — MIDI file to play on print end.

_USER_START_PRINT

Custom macro for user-defined actions at the start of printing.

This macro is automatically called at the end of the START_PRINT macro. Use it to extend the standard print initialization process with custom commands.

Common use cases:

  • Add custom heating or calibration commands
  • Perform additional setup before printing starts
  • Enable/disable devices (fans, sensors, etc.)
  • Add custom nozzle cleaning or other preparation

Example override in mod_data/user.cfg: 

[gcode_macro _USER_START_PRINT]
gcode:
    # Enable additional fan
    SET_PIN PIN=my_fan VALUE=1
    # Some custom command
    G4 P1000  ; pause for 1 second
    # Other custom actions

Note: By default, this macro is empty and can be overridden by the user according to their needs.

_USER_END_PRINT

Custom macro for user-defined actions at the end of printing.

This macro is automatically called at the end of the END_PRINT macro. Use it to extend the standard print completion process with custom commands.

Common use cases:

  • Perform additional actions after printing completes
  • Disable additional devices
  • Save statistics or logs
  • Run custom cleaning or maintenance routines

Example override in mod_data/user.cfg: 

[gcode_macro _USER_END_PRINT]
gcode:
    # Disable additional fan
    SET_PIN PIN=my_fan VALUE=0
    # Send notification
    M118 Print completed!
    # Or other custom commands

Note: By default, this macro is empty and can be overridden by the user according to their needs.

CANCEL

Cancel the current print.

CLEAR_NOZZLE

Nozzle cleaning (as in stock firmware). Parameters:

  • EXTRUDER_TEMP — extruder temperature (default: 230)
  • BED_TEMP — bed temperature (default: 80)

PRECLEAR (set via SAVE_ZMOD_DATA PRECLEAR=1) enables pre-cleaning. Learn more.

LED_ON

Turn on LED lighting.

LED_OFF

Turn off LED lighting.

LED

Set LED brightness.

  • S — brightness percentage (default: 50).

PAUSE

Pause the print.

RESUME

Resume the print after pausing.

PLAY_MIDI

Play a MIDI file.

  • FILE — filename (default: For_Elise.mid). Files are stored in mod_data/midi/.

REBOOT

Reboot the printer.

CLOSE_DIALOGS

Close dialogs on the native screen (slow method). May cause printer freezes. Controlled by the CLOSE_DIALOGS global parameter.

FAST_CLOSE_DIALOGS

Close dialogs quickly (recommended). Enable "Local Network Only" in printer settings: Settings → WiFi icon → Network Mode → Toggle "Local Network Only". Controlled by the CLOSE_DIALOGS global parameter.

NEW_SAVE_CONFIG

Trigger SAVE_CONFIG without freezing the native screen. May take ~1 minute and occasionally cause screen glitches.

SHUTDOWN

Power off the printer.

📝 Found a mistake or want to contribute? Edit this page on GitHub