Skip to main content

Firmware Compilation Guide

Important Safety Notice

To ensure system stability, please adhere to the following firmware usage principles:

  • Firmware Compilation Consistency: The Klipper firmware must be compiled using the host machine you are currently using. Using firmware compiled by others or with mismatched versions could lead to unpredictable system failures.
  • Hardware Platform Specification: It is strongly recommended to use standard host hardware. Avoid using unofficially modified devices (e.g., certain set-top boxes, WiFi sticks, or specific Redmi device models), as these may pose compatibility and stability risks.
  • Virtualization Environment Limitations: Running the host system in a virtual machine is not recommended, as it may introduce performance and real-time interference, affecting print quality.

Firmware Type Description​

  • Katapult / HID Mode

    • Function: Both modes have the same function, enabling contactless flashing (update firmware directly via the host machine without inserting/removing a memory card).
    • Explanation: HID is the Bootloader used by FLY's onboard host machine, essentially identical to Katapult.
    • Important Note: When using Katapult, if flashing incorrect firmware causes the motherboard to become unresponsive, locate the reset button on the motherboard and quickly double-click it to re-enter Katapult mode for flashing again.

  • Bootloader Mode

    • Function: Traditional flashing method using a memory card.
    • Advantage: This method is fault-tolerant. If you accidentally flash incorrect firmware, you can simply re-burn the memory card and try again, without worrying about "bricking" the motherboard.

Firmware Compilation Guide​

Compilation Preparation & Suggestions
  • To maximize the success rate of compilation, it is recommended to use MobaXterm as your SSH client. According to user feedback, some SSH tools may cause unknown compilation errors.
  • Important Configuration Item: In the compilation configuration interface, be sure to check the Enable extra low-level configuration options option, otherwise some advanced settings will not be displayed.

Startup Pin Configuration (GPIO pins to set at micro-controller startup)​

Important Note
  • This option is used to force the level state of specific GPIO pins when the microcontroller starts.
  • You need to switch to English input mode, otherwise the firmware cannot be compiled.

  • Configuration Syntax:

    • Adding ! before a pin means pulling it low (low level) at startup; omitting ! means pulling it high (high level).
    • STM32 Series: Pin numbers must be uppercase (e.g., !PF8 or PF8).
    • RP2040 Series: Pin numbers must be lowercase (e.g., !gpio5 or gpio5).

  • Multi-Pin Configuration: To configure multiple pins, separate them with a comma ,.

    • Example: !gpio5,!gpio19,gpio24 means pull gpio5 and gpio19 low at startup, while pulling gpio24 high.
Safety Explanation

The GPIO pins to set at micro-controller startup configuration only takes effect before Klipper establishes a connection. Once Klipper is connected and running normally, this setting will not affect any other operations of these pins and can be used safely.

Flash Failure Recovery & General Protection
  • Protection against flashing wrong firmware: Katapult, HID, and Bootloader firmware types have built-in protection mechanisms. As long as you do not enter special DFU mode for flashing, they will not be overwritten even if you flash the wrong main firmware, preventing the motherboard from being "bricked".
  • Required Action After Flashing: After any firmware is flashed, be sure to completely power off the secondary device (unplug the power cable), then power it back on to ensure the new firmware is correctly loaded and runs stably.

Firmware Flashing Guide​

Things to Know Before Flashing
  • Device Identification: When using Katapult for flashing, ensure the host machine can identify the device. If the device cannot be found, quickly double-click the reset button on the motherboard to re-enter flash mode.
  • Follow Standards: Strictly follow the flashing methods in the official tutorials. Using other unverified methods may cause device damage.
  • Compilation Check: Before flashing, make sure the firmware has no compilation errors. Incorrect firmware files will cause the flash to fail or the device to malfunction.

Katapult Firmware Flash Error Recovery​

  1. Locate the physical reset button on the motherboard and quickly double-click it.
  2. Under normal circumstances, an LED indicator on the Fly motherboard will start blinking, indicating successful entry into Katapult mode.
  3. You can now clear the incorrect firmware on the motherboard and re-flash the correct Klipper firmware.

Bootloader Firmware Flash Error Recovery​

  1. Re-insert the TF card containing the correct firmware into the motherboard.
  2. If flashing fails, first completely power off, insert the TF card, then power back on.
  3. Keep it powered on for approximately 5 seconds to complete the automatic flash.

Installing Katapult Flash Dependencies​

⚠️ Important
  • If you are using a non-Fly official host machine, you must run the following commands to install the firmware flash dependency packages!
  • Choose one repository below.
  • Git Repository 
    cd && git clone https://github.com/Arksine/katapult.git
  • Gitee Repository 
    cd && git clone https://gitee.com/MrCakeFuck/katapult.git
Loading...
Loading...