Skip to main content

USB Firmware Compilation

Start Compilation

Brief Guide to Firmware Compilation

Notes

  • Network: Ensure the host (Raspberry Pi, etc.) is connected to the internet.
  • Login Method: Must log in via SSH over the network; serial port access is disabled.
  • Input Method: Keep the keyboard in English half-width mode.

SSH Login and User Switching

Use tools like MobaXterm, PuTTY, etc., to SSH into the host.

Switch User:

  • Standard System (Official Raspberry Pi system, etc.)
    Do not use root; switch to a regular user:
    su <username>
  • FLY Host System (FlyOS-FAST system)
    Only supports login as root user (password: mellow)

Firmware Compilation Operation Guide

In the Klipper firmware configuration interface, only keyboard operations are supported; the mouse cannot be used.

KeyFunction
↑ / ↓Move cursor up/down to select menu items
Enter / SpaceConfirm selection, check options, or enter submenus
ESCReturn to the previous menu
QExit the configuration interface
YIf prompted when exiting, press Y to save the configuration

Start Firmware Compilation

The following describes how to compile the firmware:

  • After connecting via SSH, enter the command below and press Enter:

    cd ~/klipper && rm -rf ~/klipper/.config && rm -rf ~/klipper/out && make menuconfig
  • Among these, rm -rf ~/klipper/.config && rm -rf ~/klipper/out deletes the previous compilation data and firmware.

  • make menuconfig is for compiling the firmware; after execution, the interface below should appear.

    Loading...
  • Select Enable extra low-level configuration options and press Enter.

    Loading...
  • Enter the menu Micro-controller Architecture, then select STMicroelectronics STM32 and press Enter.

    Loading...
  • Enter the menu Processor model, select STM32F407 and press Enter.

    Loading...
  • Select Bootloader offset, choose: 32KiB bootloader.

    Loading...
  • Communication interface, select: USB (on PA11/PA12).

    Loading...
  • Press the Q key; when Save configuration appears, press the Y key.
    Loading...
  • The configuration should now be saved and you should exit to the command line interface.
  • Enter the following command to start compilation; this will take some time.
make -j4
Loading...
  • If the output below appears at the end, the compilation was successful.
  • Due to Klipper version issues, the appearance of out/klipper.bin alone indicates success.
    Linking out/klipper.elf
    Creating bin file out/klipper.bin

Flash Firmware

Preparation

  • Before starting to burn the firmware, please first connect via SSH using the network
  • Off-brand memory cards may cause burning failures. Please try to use the recommended memory cards below to update the firmware.
  • You need to prepare a TF card with a capacity not exceeding 32G, and it is recommended that the transfer speed of the TF card must be class10 or above. It is recommended to use TF cards from brands such as SanDisk.

Downloading the Firmware

  1. Use the previously prepared TF card.

  2. Format it using SDFormatter.

    Loading...
  3. Use MobaXterm_Personal to find the klipper directory in the file list on the left, then select it, find and open the out folder.

    Caution
    • Notes for standard systems
      • This applies to standard host systems such as Raspberry Pi and FLY Pi.
      • The compiled firmware is located in the /home/<your host username>/klipper/out/ directory.
      Loading...
  4. Download klipper.bin to the TF card and rename it to firmware.bin.

    firmware.bin
    Loading...
  5. Power off the motherboard and insert the TF card into the motherboard.

  6. Power on the motherboard and wait for 10 seconds.

  7. Remove the TF card and insert it into the computer. If the firmware.bin file on the SD card disappears and a file named FLY.CUR appears, the burning is successful.

    Loading...
Loading...