Skip to main content

Firmware Compilation and Burning

tip
  • CDV defaults to using a TF card for firmware burning.
  • Please prepare a TF card with a capacity not exceeding 32G.
  • Counterfeit memory cards may lead to burning failure, please try to use the recommended memory cards below for firmware updates.
  • The transmission speed of the TF card should be at least class10, it is recommended to use TF cards from brands like SanDisk.

Preparation​

  • A host machine with the installed klipper service is required Connect via SSH over the network
  • Make sure the device is connected to the host machine
  • Note: Please use a regular host machine, such as a Raspberry Pi FLY board, etc. If it's a modified host machine (e.g., WiFi stick, Redmi, etc.), due to too many issues, we cannot provide technical support for these machines
warning
  • To switch from the ROOT user to a regular user, you can enter the command below
  • Do not use the ROOT user
  • For the fly user, you can directly enter: su fly. For non-fly users, please replace <your host machine username> with your host machine's username!
su <your host machine username>

Compile Klipper Firmware​

tip
  • Please ensure that the host machine can connect to the internet normally.
  • Before compiling the firmware, you need to log in to the host machine via SSH through the network.
  • Do not use a serial port tool to log in to the host machine.

Klipper Firmware Compilation and Configuration Page Operation Instructions​

tip

Please ensure that the keyboard input method is in half-width mode, i.e., English mode.

  1. The key ↑ on the keyboard is used for moving the cursor up, and the key ↓ is used for moving the cursor down to select menu items.
  2. The confirmation key Enter or the space key Space is used to check a menu item or enter a sub-menu.
  3. The exit key ESC is used to return to the previous menu level.
  4. The Q key is used to exit the Klipper firmware configuration page.
  5. When exiting the Klipper firmware configuration page and there are prompts, press the Y key to save the configuration file.
warning

If there are fewer options in the configuration page, please first check [ ] Enable extra low-level configuration options to display some hidden options.

Below is the 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 for compiling 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 then select STMicroelectronics STM32 and press Enter

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

  • Select Bootloader offset, select: 32KiB bootloader

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

  • Press Q key, a Save configuration will appear, then press Y key

  • Now the configuration should be saved and you should exit to the command line interface

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

  • If the output is as follows, compilation is successful

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

  • The following image is an example of successful compilation

Burn Firmware​

Notice
  • CDV comes pre-installed with BL firmware that is burned via TF card.

Preparation​

  • Before starting to burn the firmware, please first connect via SSH using the network connection
  • Counterfeit memory cards may cause the burning process to fail. Please try to use the recommended memory card below for firmware updates
  • Prepare a TF card with a capacity of no more than 32G, and it is recommended that the transmission speed of the TF card must be class10 or higher. It is recommended to use brands such as SanDisk for the TF card

Download Firmware​

  1. Use the previously prepared TF card
  2. Format using SDFormatter
  3. Using MobaXterm_Personal, find klipper in the left file directory, then find out and open it
  4. And 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, insert it into the computer. If the firmware.bin in the SD card disappears and FLY.CUR appears, it indicates that the burning was successful