USB to CAN Firmware Flashing

Start Compilation

• A host computer with the klipper service installed Connect via SSH over network
• And the device should be properly connected to the host computer
• Note: Please use a standard host computer, such as Raspberry Pi, FLY board, etc. If it is a modified host computer (e.g., WiFi dongle, Redmi devices), we cannot provide technical support due to numerous issues with such hosts

Firmware Compilation Guide for Standard Host

warning

• Applies to standard host computers running systems like Raspberry Pi, FLY board, etc.
• Do not use the ROOT user for any operations on such hosts
• Please perform operations using a regular user account
• To switch users, for the FlyOS-Armbian system, please use the command su fly to switch to the regular user
• For other systems, use the command su <your host username> to switch to the regular user

su <your host username>

FAST System Firmware Compilation Guide

warning

• Notes for the FlyOS-FAST system
  • The default username for the FAST system is root, and the password is mellow
  • Firmware compilation must be performed using the root user
  • The FAST system only has the ROOT user—you do not need to switch users!!!

::: tip

• Please ensure that the host machine can connect to the network normally.
• Before compiling the firmware, use SSH to log in to the host machine via 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 make sure that the keyboard input method is in half-width mode, i.e., English mode.

:::

1. The key ↑ (up arrow) and ↓ (down arrow) on the keyboard are used to move the cursor up and down to select menu items.
2. The confirm key Enter or spacebar Space is used to check the menu or enter a sub-menu.
3. The exit key ESC is used to return to the previous menu.
4. The Q key is used to exit the Klipper firmware configuration page.
5. When exiting the Klipper firmware configuration page and there is a prompt, 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

• Among them, 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

  

• Select Communication interface, select: USB to CAN bus bridge (USB on PA11/PA12)

  

• Press the Q key, when Save configuration appears, press the Y key
  
• The configuration should now be saved and you should exit back to the command line interface
• Enter the command below to start compilation, which may take some time

make -j4

• If the compilation is successful, the final output will be similar to the following:

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

Flashing the Firmware

Preparation

• Before starting the firmware burning, please use network connection SSH
• Counterfeit memory cards may cause the burning to fail, please try to use the recommended memory cards below to update the firmware
• 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 recommended to use brands such as SanDisk

Download Firmware

1. Use the TF card you prepared earlier

2. Format with SDFormatter

   

3. Use MobaXterm_Personal to find the left file directory, find klipper, then find out to open

   FlyOS-Armbian system and general system firmware download directory

   warning

   • Notes for FlyOS-Armbian system and general system
     • Ordinary host systems such as Raspberry Pi, FLY Pi, etc., are viewed in this category
     • The compiled firmware is in the /home/<your host computer username>/klipper/out/ directory
     

   FlyOS-FAST system firmware download directory

   warning

   • Notes for FlyOS-FAST system
     • Firmware directory for FAST system
     • The compiled firmware is in the /data/klipper/out/ directory
     

4. And download klipper.bin to the TF card, and rename it to firmware.bin

   

5. Power off the mainboard, insert the TF card into the mainboard

6. On the mainboard, wait for 10 seconds

7. Remove the TF card and insert it into the computer, if the firmware.bin in the SD card disappears and FLY.CUR appears, it means the burning is successful