Setup_en - ghzserg/zmod GitHub Wiki

Setup

Restoring Printer to Factory Settings (Required for Mod Installation)

  1. Uninstall KlipperMod if previously installed.
  2. Reset the printer to default settings.
  3. Format a USB drive to FAT/FAT16/FAT32.
  4. Copy the appropriate file from the Native firmware to the USB root directory:
    • Adventurer5M-3.1.3-2.2.3-20250107-Factory.tgz for FF5M
    • Adventurer5MPro-3.1.3-2.2.3-20250107-Factory.tgz for FF5M Pro
    • AD5X-1.0.2-1.0.2-20250120-Factory.tgz for AD5X
  5. Power off the printer.
  6. Insert the usb drive into printer usb port.
  7. Power on the printer.
  8. Wait for the stock firmware installation to complete.
  9. Configure Wi-Fi or Lan new beaver
  10. Install the latest printer updates.

Installing the Mod

  1. Restore the printer to factory settings.
  2. Format a USB drive to FAT/FAT16/FAT32.
  3. Copy the mod file to the USB root directory:
    • For FF5M: Adventurer5M-zmod-*.tgz
    • For FF5M Pro: Adventurer5MPro-zmod-*.tgz
    • For AD5X: AD5X-zmod-*.tgz
  4. Power off the printer.
  5. Insert the USB drive.
  6. Power on the printer.
  7. Wait for the mod installation to complete.
  8. Remove the USB drive.
  9. Power cycle the printer.
  10. Go to Fluidd/Mainsail → Settings → Software Update. Click Check Updates and install the latest ZMOD updates.

Updating the Mod

If the mod displays Обновите ZMOD с флешки ("Update ZMOD via USB"), you must update via USB, even if recently updated.

Updating via USB preserves all data.

Simplest method: Use the ZFLASH macro. Insert the USB drive, reboot the printer, and run ZFLASH. The macro will:

  • Check for the latest version.
  • Download the latest release for your printer model.
  • Verify checksums.
  • Reboot the printer.
  • Automatically install the update (keep the USB drive inserted for future updates).

After installation:

  1. Go to Fluidd/Mainsail → Settings → Software Update.
  2. Click Check Updates and install the latest ZMOD updates.

Version Compatibility:

  • The OS version (under System → Distribution) must match the first two digits of the ZMOD version (Settings → Updates → ffm5/zmod).
  • Mismatched versions cause instability.

Update Rules:

  • USB required if the first or second version digit changes (e.g., 1.2.x → 1.3.x).
  • Online update suffices for third/fourth digit changes (e.g., 1.2.6 → 1.2.7).

Manual USB Update:

  1. Format a USB drive to FAT/FAT16/FAT32.
  2. Copy the mod file to the USB root.
  3. Power off the printer.
  4. Insert the USB drive.
  5. Power on the printer.
  6. Wait for the reboot and installation.
  7. Remove the USB drive.
  8. Power cycle the printer.

Removing or Temporarily Disabling the Mod

Recommended method: Use the REMOVE_ZMOD macro. Use USB removal only if macros are unavailable.

USB Removal:

  1. Format a USB drive to FAT/FAT16/FAT32.
  2. Copy flashforge_init.sh to the USB root.
  3. Power off the printer.
  4. Insert the USB drive.
  5. Power on the printer.
  6. Wait for three reboots.
  7. Remove the USB drive.

Updating Stock Firmware

If you have the latest ZMOD version:

  1. Update the stock firmware normally.
  2. Reboot the printer.

If ZMOD is outdated:

  1. Update ZMOD via USB first.
  2. Install online updates via Fluidd.
  3. Update the stock firmware.

Using a Stable Release Branch

To switch to a stable branch:

  1. Add to mod_data/user.moonraker.conf: 
    [update_manager zmod]  
channel: stable
  2. Stable updates are released weekly.
  3. For bug reports or new features, switch back to the latest release by removing the above lines.

Boot Recovery

Guide by @darksimpson, Alexander, @Ikaros413, @SoloMen88

Symptoms: Printer freezes on boot screen and is unreachable via LAN.

/images/ff.jpg

Steps:

  1. Unplug the printer.
  2. Prepare a 3.3V UART/USB converter (ensure jumper is set to 3.3V).

/images/ch340.jpg

  1. Open the printer’s rear panel.
  2. Connect to the UART pins (RX, TX, GND — do NOT connect 3.3V).

/images/connect.jpg

WARNING: 5V input will damage the motherboard!

  1. Connect the converter crosswise:
    • Converter RX → Printer TX
    • Converter TX → Printer RX
    • Converter GND → Printer GND

/images/connect_photo.jpg

  1. Identify the new COM port in your OS.

/images/port.jpg

  1. Open PuTTY:

    • Connection type: Serial
    • Speed: 115200
    • COM port: (e.g., COM6)

  2. Power on the printer.

  3. When Hit any key to stop autoboot appears, press Enter.

  4. In U-Boot, run:

    setenv init /bin/sh  
boot

  5. After Linux boots, remount the filesystem as writable:

    mount -t proc proc /proc  
mount -o remount,rw /

  6. Fix corrupted files (e.g., delete faulty scripts):

    rm -f /etc/init.d/S01bad_script  
rm -f /opt/config/mod/.shell/S98camera

  7. Save changes and reboot:

    sync  
reboot