Skip to main content

USB Firmware Compilation

Connect to Host Computer​

Core Connection Limitation

The Fly-D8 mainboard can only communicate with the host computer for Klipper via the Type-C USB interface.

Loading...

Below is an introduction on how to compile the firmware:

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

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

  • Here, rm -rf ~/klipper/.config && rm -rf ~/klipper/out deletes previous compilation data and firmware, and make menuconfig compiles the firmware. After execution, the following interface should appear:

    Loading...

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

    Loading...

  • Navigate to the Micro-controller Architecture menu, then select STMicroelectronics STM32 and press the Enter key:

    Loading...

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

    Loading...

  • Select Bootloader offset and choose: 128KiB bootloader:

    Loading...

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

    Loading...

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

    Loading...
  • Press the Q key, and when Save configuration appears, press the Y key:
    Loading...
  • The configuration should now be saved, and you will exit back to the command line interface.
  • Enter the following command to start compilation. This may take some time: 
    make -j4
    Loading...
  • If the following content is output at the end, the compilation is successful.
  • Due to Klipper version differences, as long as out/klipper.bin appears, it indicates success: 
    Linking out/klipper.elf
    Creating bin file out/klipper.bin

Enter Flashing Mode​

  • After connecting the mainboard to the host computer using a Type-C data cable, double-click the RST button. At this point, the LED light on the mainboard will flash.
Warning
  • If the LED light does not flash, please re-flash the katapult firmware: Flash katapult firmware
  • If the LED light does not flash, after flashing the katapult firmware, proceed to the next step.
Loading...
  • Please ensure that the host machine can connect to the network normally and ensure that the data cable connecting the lower-level machine to the host machine has data transmission function.
  • After SSH connecting to the host machine, input lsusb and press Enter. If the information circled in the following picture appears, you can proceed to the next step.
    • If there is no feedback at all, this is a system problem of the host machine, and we are unable to help. You need to replace with a confirmed normal system or replace the host machine.
    • If the prompt says there is no lsusb command, you can execute the following command to install it: 
      sudo apt-get install usbutils
      Loading...
  • 1d50:6177 belongs to the device you will use this time.
    • Some host machines may not fully display or fail to display due to system problems.
    • If the lsusb command can display the device but does not show 1d50:6177, please try replacing the data cable and connecting the mainboard to another USB port on the host machine.
  • If you have executed the above steps before and successfully burned the Klipper firmware, and the mainboard is running normally, but you just want to update the Klipper firmware, please directly check the Firmware Update section in the right menu bar of this page.
Notice

You must query the 1d50:6177 device before proceeding to the next step.

Flash Firmware​

Start Flashing​

📌 Prerequisites
  • Internet connection is required when installing the flashing plugin. Please ensure your host computer is connected to the internet.
  • If the flashing plugin is already installed, there is no need to reinstall it.

Install Flashing Dependencies​

⚠️ Important

If you are using a non-Fly official host computer, you must execute the following command to install the firmware flashing dependency package!

cd && git clone https://github.com/Arksine/katapult.git
Loading...

Get Board ID​

Execute the following command to search for the device ID. Normally, an ID similar to the one shown in the image below should be displayed (Note: The ID is different for each board):

ls /dev/serial/by-id/*
Loading...

Flash Firmware​

⚠️ Preparation
  • Ensure the firmware file has been compiled.
  • Replace <Your Board ID> in the command below with the actual ID queried in the previous step.
python ~/katapult/scripts/flashtool.py -d /dev/serial/by-id/<Your Board ID>

Flashing Process Reference:

Loading...

Successful Flashing Reference:

Loading...

Firmware Update​

USB Firmware Update Steps​

  1. Query Board ID
ls /dev/serial/by-id/*
Identification Key

In the image below, /dev/serial/by-id/usb-katapult_rp2040_E662549553642032-if00 is the board ID.

Loading...
  1. Update Firmware
cd ~/klipper/ && make flash FLASH_DEVICE=<Your Board ID>
Note
  • Replace <Your Board ID> with the actual queried ID.
Loading...

Solution for Flashing Wrong Firmware​

Method 1: Quickly Enter Flashing Mode​

  1. Power off the board.
  2. After powering on again, quickly double-click the RESET button.
  3. Re-enter flashing mode.

Method 2: Re-flash Katapult Firmware​

Click to View Katapult Firmware Flashing Guide
Loading...