Skip to main content

USB Firmware Compilation

Getting Started with Compilation​

  • You need an upper computer with the klipper service installed Connect via SSH over the network
  • And make sure the device is connected to the upper computer
  • Note: Please use a regular upper computer, such as a Raspberry Pi FLY board, etc. If you are using a modified upper computer, we cannot provide much assistance due to too many issues.
Note
  • Do not use the ROOT user
tip
  • 请确保上位机可以正常联网
  • 固件编译前需要使用SSH通过网络登录上位机
  • 请不要使用串口工具登录上位机

Klipper固件编译配置页面操作说明​

tip

请确保键盘输入法为半角模式，即英文模式

  1. 键盘上键↑，下键↓，用于上下移动光标来选中菜单项
  2. 确认键Enter 或 空格键Space，用于勾选菜单或进入子菜单
  3. 退出键ESC，用于返回上一级菜单
  4. Q键，用于退出Klipper固件配置页面
  5. Y键，在退出Klipper固件配置页面时，如果有提示，则点击Y键保存配置文件
warning

如果配置页面选项比较少，请先勾选[ ] Enable extra low-level configuration options，用于显示部分隐藏选项

Below is an introduction on how to compile the firmware:

  • After connecting to SSH, enter the following command and press Enter:

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

  • Where rm -rf ~/klipper/.config && rm -rf ~/klipper/out is to delete previous compilation data and firmware. make menuconfig is to compile the firmware. After execution, the following interface should appear:

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

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

  • Enter the menu Processor model, select STM32H723 and press Enter

  • Select Bootloader offset, choose: 128KiB bootloader

  • Select Clock Reference (8 MHz crystal), choose: 25 MHz crystal

  • Communication interface, choose: USB (on PA11/PA12)

  • Press the Q key, and when Save configuration appears, press the Y key again.

  • You should now have saved the configuration and exited to the command line interface.

  • Enter make -j4 to start compiling; this may take some time.

  • If the following output is displayed at the end, compilation is successful:

    Linking out/klipper.elf
    Creating hex file out/klipper.bin

Firmware Flashing​

Preparation​

  • Before flashing the firmware, please first connect via SSH using the network
  • Counterfeit memory cards may cause flashing failure, please try to use the recommended memory cards below for firmware update
  • 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 higher, it is suggested to use brands like SanDisk for the TF card

Download Firmware​

  1. Use the prepared TF card
  2. Format using SDFormatter
  3. Use MobaXterm_Personal to navigate to the file directory on the left side, find klipper, then open out
  4. Download klipper.bin to the TF card and rename it to firmware.bin
  5. Power off the motherboard, insert the TF card into the motherboard
  6. On the motherboard, wait for 10 seconds
  7. Remove the TF card and insert it back into the computer. If the firmware.bin in the SD card disappears and FLY.CUR appears, the flashing is successful.