Skip to main content

Firmware Compilation and Flashing

tip
  • CDV defaults to using an SD card for firmware flashing
  • Please prepare an SD card with a capacity of no more than 32G
  • Cheap memory cards may cause flashing failures, please try to use the recommended memory cards below for firmware updates
  • The SD card's transfer speed should be at least class10, it is recommended to use brands like SanDisk

Preparation​

  • 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

Compile Klipper Firmware​

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 command below and press Enter:

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

  • Among them, rm -rf ~/klipper/.config && rm -rf ~/klipper/out is to delete previous compilation data and firmware, and 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 STM32F407 and press Enter

  • Select Bootloader offset, choose: 32KiB bootloader

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

  • Press Q key, then Save configuration appears, press Y key again

  • Now you should have saved the configuration and exited to the command line interface

  • Enter make -j4 to start compiling, it takes some time

  • When the following output is displayed, compilation is successful

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

  • The following is an example of a successful compilation

Flashing Firmware​

Notice
  • CDV comes pre-flashed with BL firmware for SD card 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.