Skip to main content

USB Firmware Compilation

Start Compiling​

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

Starting Firmware Compilation​

Below is an introduction on how to compile the firmware:

  1. Connect via SSH, enter the following command, and press Enter:

    cd ~/klipper && rm -rf ~/klipper/.config && rm -rf ~/klipper/out && make menuconfig

    Here, rm -rf ~/klipper/.config && rm -rf ~/klipper/out is used to clear previous compilation configurations and firmware; make menuconfig is used to open the Klipper firmware configuration interface.

  2. Follow the order below to set each item one by one, completing each before moving on to the next.

    1启用 Enable extra low-level configuration options
    (Top)
    Klipper Firmware Configuration
    [*] Enable extra low-level configuration options
    2Micro-controller Architecture 选择 STMicroelectronics STM32
    (Top)
    Klipper Firmware Configuration
    [*] Enable extra low-level configuration options
    Micro-controller Architecture (STMicroelectronics STM32) --->
    3Processor model 选择 STM32F407
    (Top)
    Klipper Firmware Configuration
    [*] Enable extra low-level configuration options
    Micro-controller Architecture (STMicroelectronics STM32) --->
    Processor model (STM32F407) --->
    4Bootloader offset 选择 32KiB bootloader
    (Top)
    Klipper Firmware Configuration
    [*] Enable extra low-level configuration options
    Micro-controller Architecture (STMicroelectronics STM32) --->
    Processor model (STM32F407) --->
    Bootloader offset (32KiB bootloader) --->
    5Clock Reference 选择 8 MHz crystal
    (Top)
    Klipper Firmware Configuration
    [*] Enable extra low-level configuration options
    Micro-controller Architecture (STMicroelectronics STM32) --->
    Processor model (STM32F407) --->
    Bootloader offset (32KiB bootloader) --->
    Clock Reference (8 MHz crystal) --->
    6Communication interface 选择 USB (on PA11/PA12)
    (Top)
    Klipper Firmware Configuration
    [*] Enable extra low-level configuration options
    Micro-controller Architecture (STMicroelectronics STM32) --->
    Processor model (STM32F407) --->
    Bootloader offset (32KiB bootloader) --->
    Clock Reference (8 MHz crystal) --->
    Communication interface (USB (on PA11/PA12)) --->
    7启用 Optimize stepper code for 'step on both edges'
    (Top)
    Klipper Firmware Configuration
    [*] Enable extra low-level configuration options
    Micro-controller Architecture (STMicroelectronics STM32) --->
    Processor model (STM32F407) --->
    Bootloader offset (32KiB bootloader) --->
    Clock Reference (8 MHz crystal) --->
    Communication interface (USB (on PA11/PA12)) --->
    USB ids --->
    [*] Optimize stepper code for 'step on both edges'
    8按 Q 键退出配置界面
    (Top)
    Klipper Firmware Configuration
    [*] Enable extra low-level configuration options
    Micro-controller Architecture (STMicroelectronics STM32) --->
    Processor model (STM32F407) --->
    Bootloader offset (32KiB bootloader) --->
    Clock Reference (8 MHz crystal) --->
    Communication interface (USB (on PA11/PA12)) --->
    USB ids --->
    [*] Optimize stepper code for 'step on both edges'
    () GPIO pins to set at micro-controller startup
    9出现 Save configuration 时按 Y 保存配置
    Quit
    Save configuration?
    (Y)es(N)o(C)ancel

  3. After completing the last two steps above, press Q to exit the configuration interface, then press Y to save the configuration.

  4. Return to the command line and enter the following command, then press Enter to start compiling:

    make -j4
    root@flyos-11e5f8 ~/klipper # make -j4
    Compiling out/src/stm32/spi.o
    Compiling out/src/stm32/i2c.o
    Compiling out/src/stm32/usbotg.o
    Compiling out/src/stm32/chipid.o
    Compiling out/src/generic/usb_cdc.o
    Compiling out/src/stm32/hard_pwm.o
    Compiling out/src/stm32/sdio.o
    Preprocessing out/src/generic/armcm_link.ld
    Building out/compile_time_request.o
    Version: XXXX
    Linking out/klipper.elf
    Creating bin file out/klipper.bin

    终端末尾出现 Linking out/klipper.elf 和 Creating bin file out/klipper.bin，即表示编译成功。 实际编译时，部分 Compiling 行和 Version 会随 Klipper 与系统版本变化。

Burn Firmware​

Preparation​

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

Download Firmware​

  1. Use the TF card prepared earlier

  2. Format it using SDFormatter

    Loading...

  3. Use the file directory on the left side of MobaXterm_Personal to find klipper, select it, then find out and open it

    Caution
    • Notes for regular systems
      • This category applies to regular 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. And download klipper.bin to the TF card, and rename it to firmware.bin

    firmware.bin
    Loading...
Windows file extension display

Windows may hide file extensions by default, making it easy to actually save the file as firmware.bin.txt or firmware.bin.bin. Before renaming the firmware, please enable extension display in File Explorer:

  1. Open any folder.
  2. Click View at the top.
  3. Check File name extensions.
  4. When renaming the file, confirm that the full file name is firmware.bin.
  1. Power off the mainboard and insert the TF card into the mainboard
  2. Power on the mainboard and wait 10 seconds
  3. Remove the TF card and insert it into the computer. If firmware.bin on the SD card disappears and FLY.CUR appears, the flashing was successful
    Loading...

Search for USB ID After Burning​

After firmware burning is completed and the motherboard is powered on again, continue to search for the USB ID.

View methods to determine USB ID

Loading...