Skip to content

System_en

TMTYD edited this page May 13, 2025 · 6 revisions

System Macro List

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

It can be called from:

  • A GCODE file
  • The Fluidd/Mainsail console (press the C key in Fluidd).

Note

Default values are shown in parentheses.


🔷 System 🔷
SHUTDOWN CAMERA ON CAMERA OFF CAMERA RESTART REMOVE ZMOD
SKIP ZMOD DISPLAY ON DISPLAY OFF MEM TEST EMMC
CLEAR EMMC DATE GET DATE SET WEB SET TIMEZONE
TAR CONFIG RESTORE TAR CONFIG ZFLASH STOP ZMOD START ZMOD
CHECK MD5 UPDATE MCU CHECK SYSTEM ZSSH ON START ZSSH
ZSSH OFF ZSSH RESTART ZSSH RELOAD SSH Keys

SHUTDOWN

Power off the printer.

⬆️ Top


CAMERA_ON

Use alternative camera implementation

Disable the camera on the printer screen, and only then call the macro

Consumption of RAM on the stock chamber:

  • 640x480 - 2.9 MiB
  • 1280x720 - 7.8 MiB
  • 1920x1080 - 18.1 MiB

Many cameras with Ali/Ozon/Wildberries always consume 18 MiB

Enable alternate camera.

  • WIDTH: Resolution width (640).
  • HEIGHT: Resolution height (480).
  • FPS: Framerate (20).
  • VIDEO: Camera device (video0).
  • FS: Fix frame size for unstable cameras (0 = off).

CAMERA_OFF

Disable alternate camera.

CAMERA_RESTART

Restart alternate camera.

⬆️ Top


REMOVE_ZMOD

Remove zmod.

The /opt/config/mod_data folder stores configurations for zmod, fluidd, moonraker, and mainsail.

By default, it is not deleted because users often accidentally run the REMOVE_ZMOD macro.

** REMOVE_ZMOD ** Uninstall ZMOD.

  • FULL=0: Keep /opt/config/mod_data (default).
  • FULL=1: Delete all configs.

⬆️ Top


SKIP_ZMOD

Reboot into the original system without launching zmod.

Disables configuration files for ZMOD, Moonraker, and Fluidd.

Note

Reboot into stock firmware (disables ZMOD services).

The following remain active:

  • Alternative camera
  • SSh

⬆️ Top


DISPLAY_ON

Enable native screen and reboot.

DISPLAY_OFF

Disable native screen to save RAM.

  • GUPPY=0: Disable GuppyScreen.
  • GUPPY=1: Enable GuppyScreen (default).

⬆️ Top


MEM

Show memory usage.

TEST_EMMC

Test storage performance.

  • SIZE: Data size in MB (100).
  • SYNC: Sync mode (1 = enabled).
  • FLASH: Test target (0=EMMC, 1=USB, 2=RAM).
  • RANDOM: Use random data (0=off).

CLEAR_EMMC

Clear logs/files.

  • LOG=1: Clear logs (default).
  • ANY=1: Clear all non-log files.

⬆️ Top


DATE_GET

Show current time.

DATE_SET

Set system time (format: YYYY.MM.DD-HH:MM:SS).

Example: DATE_SET DT=2024.01.01-00:00:00

⬆️ Top


WEB

Switch between Fluidd and Mainsail.

SET_TIMEZONE

Set timezone.

Example: SET_TIMEZONE ZONE=Asia/Yekaterinburg

⬆️ Top


TAR_CONFIG

Backup logs and configs.

Note

Backup configs to mod_data/config.tar.

RESTORE_TAR_CONFIG

Restores configuration files from the config.tar archive

The archive must be loaded in Configuration -> mod_data -> config.tar

⬆️ Top


ZFLASH

Update ZMOD via USB.

⬆️ Top


STOP_ZMOD

Stop Moonraker/Fluidd.

START_ZMOD

Start Moonraker/Fluidd.

⬆️ Top


CHECK_MD5

Validate G-code MD5 checksums.

  • DELETE=yes: Delete corrupted files.

UPDATE_MCU

Update MCU firmware.

Note

Experimental - Update MCU firmware (Klipper v12).

CHECK_SYSTEM

Verify OS file integrity.

  • RESTORE=1: Auto-repair files.

⬆️ Top


ZSSH_ON

Enable SSH server. Enable SSH tunneling to remote server.

  • SSH_SERVER: Server IP/hostname.
  • SSH_PORT: SSH port (22).
  • SSH_USER: Remote username.
  • VIDEO_PORT: Camera port (8080).
  • MOON_PORT: Moonraker port (7125).
  • REMOTE_RUN: Command to execute on server (e.g., ./ff5m.sh bot1).

START_ZSSH

Run ZSSH_ON on the printer.

SSH_Keys

Add your SSH public key to authorized_keys on the printer.

⬆️ Top


ZSSH_OFF

Disable SSH server.

ZSSH_RESTART

Restart SSH server.

ZSSH_RELOAD

Reload SSH configuration. (called automatically during prints).


⬅️ Back ⬆️ Top ➡️ Forward

Clone this wiki locally